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

Add Wiki for internal documentation #346

Open
phamkv opened this issue May 2, 2024 · 1 comment
Open

Add Wiki for internal documentation #346

phamkv opened this issue May 2, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation priority:low Set by the PO only

Comments

@phamkv
Copy link
Collaborator

phamkv commented May 2, 2024

It would be great to utilize the Wiki functionality in GitHub repo or do it elsewhere (look for alternatives). It can be informal (to store links and information related before they are forgotten) and can have a defined structure (a styleguide how wiki entries should look like).

@ChristianHuehn
Copy link
Collaborator

As discussed, we should do this only for concepts instead of code parts. We can use the project wiki for it. :) we could think of it as architecture documentation. We could use something like arc42 as format

@ChristianHuehn ChristianHuehn added documentation Improvements or additions to documentation priority:low Set by the PO only labels May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority:low Set by the PO only
Projects
None yet
Development

No branches or pull requests

2 participants