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

Redesing the codeowners documentation #50

Open
mszostok opened this issue Oct 26, 2020 · 0 comments
Open

Redesing the codeowners documentation #50

mszostok opened this issue Oct 26, 2020 · 0 comments
Labels
documentation enhancement New feature or request
Milestone

Comments

@mszostok
Copy link
Owner

Description

Currently, most of the validator documentation is placed in main README.md file. This makes it hard to read and check which sections are described.

In this task documentation should be split to a dedicated .md files. The ToC in /docs folder should be updated.

Scratch: expose documentation using some static state generator, e.g.:

Reasons

It needs to be more readable to the user. Necessary information should be available in easy way.

@mszostok mszostok added enhancement New feature or request documentation labels Oct 26, 2020
@mszostok mszostok added this to the v0.6.0 milestone Oct 26, 2020
@mszostok mszostok modified the milestones: v0.6.0, v0.7.0 Jan 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant