WarmHub Docs
  • Welcome to WarmHub
  • Getting Started
  • The Language of Digital Trust
    • Articles, Claims, Evidence, and Sources
    • Reproductions and Replications
  • Trust Repositories
    • Creating a Repository
    • ReadMe
    • Data
      • Templates for Typed Instance Data
    • Types
      • Importing Types From Other Repos
      • Creating Types
      • Claims Computed on WarmHub
    • Events
    • Webhooks
    • About
    • Committing To Your Repo
    • Customizing Templates
      • Template Language Reference
  • Guides
    • Units of Measurement Repo
    • Templates for Units of Measurement
Powered by GitBook
On this page
  1. Trust Repositories

ReadMe

Every repo in WarmHub has a ReadMe page. Think of this, as the marketing page for your repo and all of the data contained inside.

Use your ReadMe page to tell visitors:

  • Why you created this repo

  • How they should use the repo, including how they should navigate and process the data

  • The licensing that applies to the data inside the repo, which specifies how it can be used

  • Highlight specific data elements from inside your repo

Editing The ReadMe Layout

By default, all ReadMe page share the name of the repo, and its description. However, the ReadMe page can be customized using MarkDown.

To edit the layout, first click the "Edit Layout" button in the upper right hand corner of the ReadMe page.

  • If you do not see the "Edit Layout" button, it is most likely that you do not have the permissions to edit this repo.

For more information, see: Customizing Templates

PreviousCreating a RepositoryNextData

Last updated 2 days ago