Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to present user docs and developer docs #54

Open
bjones1 opened this issue May 25, 2022 · 0 comments
Open

How to present user docs and developer docs #54

bjones1 opened this issue May 25, 2022 · 0 comments

Comments

@bjones1
Copy link
Owner

bjones1 commented May 25, 2022

For many applications -- certainly, CodeChat and the CodeChat System -- there will be both user docs and developer docs. What's the best way to structure these? We need some documentation principles added to CodeChat/docs/style_guide.cpp.

Thoughts:

  • Have two separate doctree hierarchies. The homepage will always be the user docs.
  • Provide links between user and developer docs at similar levels of the hierarchy.
  • Define a naming convention: user-file.rst and dev-file.rst?

After defining this, update the actual CodeChat / CodeChat System docs to use this approach.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant