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

Feature request: make docs part of the main repository #380

Open
chowette opened this issue Dec 3, 2020 · 1 comment
Open

Feature request: make docs part of the main repository #380

chowette opened this issue Dec 3, 2020 · 1 comment

Comments

@chowette
Copy link
Contributor

chowette commented Dec 3, 2020

Hi,

When making improvement to the source code, you always need to update the documentation accordingly.
Today, the doc is in a wiki which is part of a separate repository.

It would be nice to host the docs directly in a /docs/ folder so the documentation change can be part of the PR and commit history.

This will also enable easy integration with other tools like mkdocs and readthedocs and continuous build using github actions

See Continuous Documentation: Hosting Read the Docs on GitHub Pages

You can still edit and preview .md files from github web interface like the wiki

What do you think?

@the0ne
Copy link
Collaborator

the0ne commented Dec 2, 2022

The disadvantage would be that the Wiki would no longer work, right?
Can you create a PR to show how it could look?

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