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

separate documentation #29

Open
SKairinos opened this issue Nov 27, 2023 · 0 comments
Open

separate documentation #29

SKairinos opened this issue Nov 27, 2023 · 0 comments
Labels

Comments

@SKairinos
Copy link
Contributor

As part of our dev workflow we need to start including all documentation regarding a repo's code within that repo. All documentation should be contained within the /docs directory. This makes it possible to include docs in our PRs going forward so that when a code change happens, we also update the appropriate documentation (if necessary).

The problem is that our code-specific and non-code-specific documentation is mixed together in the same GitBook spaces. We should create at least one dedicated space per repo and sync them to that repo. All non-code-specific documentation should be in their own spaces and not synced to any repo.

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

No branches or pull requests

2 participants