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

Migrate module documentation to source code repository #4751

Open
lassoan opened this issue Mar 20, 2020 · 1 comment · May be fixed by #4771
Open

Migrate module documentation to source code repository #4751

lassoan opened this issue Mar 20, 2020 · 1 comment · May be fixed by #4771

Comments

@lassoan
Copy link
Contributor

@lassoan lassoan commented Mar 20, 2020

It is very hard to keep implementation and documentation in sync when they are stored on two separate systems (git repository and wiki). We should generate documentation (both user manual and developer documentation) from files stored in the source code repository.

@jcfr

This comment has been minimized.

Copy link
Member

@jcfr jcfr commented Mar 25, 2020

@jcfr jcfr linked a pull request that will close this issue Mar 25, 2020
0 of 4 tasks complete
@jcfr jcfr linked a pull request that will close this issue Mar 25, 2020
0 of 4 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Linked pull requests

Successfully merging a pull request may close this issue.

2 participants
You can’t perform that action at this time.