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

Standard documentation for all projects #18

Open
cyrildewit opened this issue Dec 21, 2021 · 0 comments
Open

Standard documentation for all projects #18

cyrildewit opened this issue Dec 21, 2021 · 0 comments

Comments

@cyrildewit
Copy link
Member

cyrildewit commented Dec 21, 2021

Description

Some information is tightly coupled to a project. For example code review guidelines that are project specific (due to technology), REST API documentation or information about the code architecture. It would be nice if each project has a standard place to put this kind of information in. This will allow us to create a shared knowledge base of practical information about the project.

We can document information that's useful for developers, but also information that users of the product can use. We can always relocate this information in the future to make it more accessible.

Proposal

I would like to propose to setup a documentation integration with GitHub pages to automatically publish the documentation live.

We can use the same setup as what we use for the guides website. See https://ka-huis.github.io/guides/ for an example.

I would like to hear if you find this a good idea. @joeyvonck @abassharif @MiKessels

@cyrildewit cyrildewit self-assigned this Dec 21, 2021
@cyrildewit cyrildewit added this to To do in Project Board via automation Dec 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

1 participant