This repository has been archived by the owner on Jan 9, 2023. It is now read-only.
[TRACKING ISSUE] Docs 1.0 #989
Labels
docs
issue/pull request that includes changes to documentation
help wanted
indicates that an issue is open for contributions
We sorely need better HospitalRun docs. Currently, we don't have any end user docs, and our developer documentation is limited.
This issue is for high level discussion and planning for our overall docs content strategy. All PR's and other issues that relate to Docs should reference this issue, and be referenced in this issue for tracking purposes.
Scope and stages
To properly scope work on our documentation, here's a first pass at a phasing outline:
1. Make developer docs more comprehensive
Currently we have some basic developer documentation in the README, Contributing guide, and Wiki. But we need a more comprehensive set of developer docs. Here's a basic outline to get us started:
(@HospitalRun/core-maintainers feel free to edit this outline)
2. Publish developer docs
We need to get the developer docs into a centralized, easily accessible location. Right now they are spread apart across the README, CONTRIBUTING doc, and wiki.
Let's get them centralized onto the Docs site. It would be great if we had a way to include them both in the frontend repo, and on the docs site (hospitalrun.io). Thinking we might be able to accomplish that with a separate repo called
/docs
, and just include that as a git submodule in both the app, and the marketing site. Thoughts on that approach?3. Write end user help docs
Finally, we need a good story for end user help documentation. Ultimately I think that should be accessible directly from the application, but might also be helpful to have that available at hospitalrun.io as well. If the submodule approach works well for developer docs, perhaps we could use that approach for end user help docs too?
Where help is needed:
We're going to need a bunch of help with this effort. Here's the shortlist that I can identify (again, @HospitalRun/core-maintainers please contribute to this list where I've left anything out, or where it could be clearer):
/docs
and/user-help
repo as git submodulescc @HospitalRun/core-maintainers
The text was updated successfully, but these errors were encountered: