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

create a readthedocs page #117

Open
jeremymanning opened this issue Oct 27, 2023 · 0 comments
Open

create a readthedocs page #117

jeremymanning opened this issue Oct 27, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jeremymanning
Copy link
Member

Good suggestion from one of our SoftwareX reviewers:

I suggest creating a documentation website using an option like Sphinx and ReadTheDocs.org, which provides free hosting, or using a wiki on GitHub. The Sphinx + RTD option is nicer and more flexible, but takes more setup. In either case, the main benefit would be having separate pages that could split out things like user guide, FAQ, implementation details, and grammar specifications. For the README file, I suggest just having a brief introduction and a quick example of using Davos to get people started, with those two things taking up a about a page. A link to an FAQ section can still be included to refer skeptical readers, but I think the pitch in the README can be very simple and focused on the benefits of Davos, rather than trying to contrast with all the other available systems. The quick start section can show simple examples to help play up a strength of Davos, which is that most users will need to read very little documentation to get started.

@jeremymanning jeremymanning added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant