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 do you document entire project (maybe put on Introduction html page?) #191

Open
gw666 opened this issue Feb 21, 2020 · 1 comment
Open

Comments

@gw666
Copy link

gw666 commented Feb 21, 2020

I'd like to write documentation for the whole project--e.g., how to use it, what to keep in mind, etc. Maybe this is already possible; I couldn't find a way to do it.

Putting this documentation on the Introduction html page would be nice. Thanks.

@weavejester
Copy link
Owner

I don't know if this is exactly what you want, but in the README there's a section called documentation files that explains how to add arbitrary doc files.

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

2 participants