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

Make a separate manual page for store implementations #8496

Closed
fricklerhandwerk opened this issue Jun 12, 2023 · 3 comments
Closed

Make a separate manual page for store implementations #8496

fricklerhandwerk opened this issue Jun 12, 2023 · 3 comments
Labels
documentation good first issue Quick win for first-time contributors

Comments

@fricklerhandwerk
Copy link
Contributor

fricklerhandwerk commented Jun 12, 2023

Problem

Currently store parameters are documented in the man page for a special-purpose command.

Proposal

Add a section in the manual with a page per store implementation listing all parameters. It could go under the Protocols section. Add anchors to all parameters so they can be linked to directly.

Priorities

Add 👍 to issues you find important.

@Mash707
Copy link

Mash707 commented Aug 11, 2023

Hii @fricklerhandwerk I am new to open source and would like to contribute to this issue. From my Understanding we have create a new page for each store implementation , club them under a section and this section should be under Protocols section.

@fricklerhandwerk
Copy link
Contributor Author

Thanks for your support! @Ericson2314 just recently opened a PR: #8781

You could definitely help with figuring out where to put the information such that it's both available on the command line and on the web as conveniently and easy to discover as possible. See the discussion on the PR for details.

@fricklerhandwerk
Copy link
Contributor Author

Closed by #9504

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue Quick win for first-time contributors
Projects
None yet
Development

No branches or pull requests

2 participants