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

Improve configuration documentation #876

Open
kaylareopelle opened this issue Feb 20, 2024 · 1 comment
Open

Improve configuration documentation #876

kaylareopelle opened this issue Feb 20, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed keep Ensures stale-bot keeps this issue/PR open

Comments

@kaylareopelle
Copy link
Contributor

YARD/RDoc doesn't provide a great way for us to add documentation for our configuration options

Ideas:

  • Automate addition of config documentation to READMEs for individual gems
  • Automate a section in instrumentation-all that lists the config options for all the gems that get installed

See #825 as one example for README-style documentation
@github-actions GitHub Actions
Copy link
Contributor

👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.

@github-actions github-actions bot added the stale Marks an issue/PR stale label Mar 22, 2024
@kaylareopelle kaylareopelle added keep Ensures stale-bot keeps this issue/PR open and removed stale Marks an issue/PR stale labels Mar 27, 2024
@kaylareopelle kaylareopelle added documentation Improvements or additions to documentation help wanted Extra attention is needed labels May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed keep Ensures stale-bot keeps this issue/PR open
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kaylareopelle