Project documentation

[matteovivona]

Create end-users and developers documentation. The end-user documentation must also be navigable in offline mode.

The documentation will be hosted on:

• docs.hospitalrun.io for final users
• developers.hospitalrun.io for developers

Current strategy

@hosptialrun-org/docs

Typescript Create React App that hosts docs.hospitalrun.io for general use and for sharing templates to other modules. Also a standard interface for collecting metadata about the current project via hospitalrun docs command. Includes Shared StoryBook Components like ReadmePage.tsx which uses the same templates as the cli readme generator.

@hospitalrun-org/hospitalrun

Will host developers.hospitalrun.io for contribution guides and route to component storyboard/generic documentation. We can use the mono repo to generate it's documentation by using a standard ./docs folder for each project. This would mean that @hospitalrun/frontend's developer documentation would be hosted in it's local ./docs folder with meta.json data about it's routes\components. The metadata would be loaded into the mono-repo documentation generator. See component documentation generation for an example of getting metadata from react documentation.

Example Future Use

# Inside of package
hospitalrun docs
# outputs ./docs/meta.json and documentation for developers.hospitalrun.io/package-name

# inside of mono-repo
hospitalrun docs
# looks for all package metadata to build a "Shell" that links to each project page.

Backlog:

• create hospitalrun-docs repository
• create hospitalrun-docs application
• move components docgen command to hospitalrun docs
• create mono-repo developer documentation generator using package metadata and StoryBooks
• point docs.hospitalrun.io to hospitalrun-docs github page
• Point package pages to developers.hospitalrun.io/package-name

[matteovivona]

Another question I had is where would we like the documentation to live? There are tools that can have it go in storybook, we can generate it to a docs/ folder, we can do both, or we can do something completely different. What are people's thoughts?
_{View in Slack}

[ashutoshanand13]

Hi,

Can I work on this?

Are there any documents that are already present? I believe the application should have documentation for usage. I checked the following https://docs.hospitalrun.io/ but couldn't find any relevant document.

[matteovivona]

Hi @ashutoshanand13, right now the notion to write in the documentation is still to be defined, so I couldn't even tell you where to start.