Skip to content

Standard documentation for all projects #18

@cyrildewit

Description

@cyrildewit

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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions