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.

Sign up for GitHub

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

Jump to bottom

Suggestion: Add docs on how docs are being built #10

Closed
sappelhoff opened this issue Sep 5, 2020 · 3 comments
Closed

Suggestion: Add docs on how docs are being built #10

sappelhoff opened this issue Sep 5, 2020 · 3 comments
Labels
high priority Address before final evaluation. JOSS review https://github.com/openjournals/joss-reviews/issues/2621

Comments

@sappelhoff
Copy link
Contributor

sappelhoff commented Sep 5, 2020 •
edited
Loading

related to JOSS review (openjournals/joss-reviews#2621)

I think it'd be helpful for potential contributors (or your future self) to have a short paragraph with information on how the documentation is being build and deployed. A good place for this documentation would be in the contributors guide.
@whedon whedon mentioned this issue Sep 5, 2020
Closed
60 tasks
@sappelhoff
Copy link
Contributor Author

another note: when adding docs on how to build docs, perhaps it'd be worth adding also docs for contributors on how to install a "development version" of the repository (which is required for making PRs)

@JanCBrammer JanCBrammer added JOSS review https://github.com/openjournals/joss-reviews/issues/2621 high priority Address before final evaluation. labels Sep 29, 2020
@JanCBrammer
Copy link
Owner

@sappelhoff, see f2d6101.

@sappelhoff
Copy link
Contributor Author

looks good to me, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
high priority Address before final evaluation. JOSS review https://github.com/openjournals/joss-reviews/issues/2621
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@sappelhoff @JanCBrammer