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.

Sign up for GitHub

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

Jump to bottom

[Meta]: Auto-generate configuration documentation #381

Open
mrjones2014 opened this issue Jun 22, 2023 · 0 comments
Open

[Meta]: Auto-generate configuration documentation #381

mrjones2014 opened this issue Jun 22, 2023 · 0 comments
Assignees
@mrjones2014
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed meta Something regarding repo steup, CI, issue templates, etc. PRs-welcome I'd love to see a PR for this

Comments

@mrjones2014
Copy link
Owner

Category

Docs

Description

Currently my workflow when adding new config options is to define the option, write doc-comments, then copy-paste the changed into the README.md.

Telescope.nvim does stuff to autogenerate these. We should look at how they do it, and figure out how to avoid having to manually copy/paste.
@mrjones2014 mrjones2014 added the meta Something regarding repo steup, CI, issue templates, etc. label Jun 22, 2023
@mrjones2014 mrjones2014 self-assigned this Jun 22, 2023
@mrjones2014 mrjones2014 added documentation Improvements or additions to documentation help wanted Extra attention is needed PRs-welcome I'd love to see a PR for this labels Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mrjones2014 mrjones2014

Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed meta Something regarding repo steup, CI, issue templates, etc. PRs-welcome I'd love to see a PR for this
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mrjones2014