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

Improve documentation for contributing #1800

Open
2 tasks
dana-gill opened this issue Jan 29, 2024 · 0 comments
Open
2 tasks

Improve documentation for contributing #1800

dana-gill opened this issue Jan 29, 2024 · 0 comments
Labels
documentation Issues relating to docstrings, examples, and documentation build

Comments

@dana-gill
Copy link

Is your feature request related to a problem? Please describe.
Upon trying to start contributing to librosa to make improvements for the documentation, I encountered a few problems. The first is CONTRIBUTING.md is not accessible via the website, and I had to look through the repository to find it. The second is that the file for Compiling Documentation is not referenced in the Contributing Page. The documentation is unfortunately a bit scattered which makes it difficult for first-time contributors 😞

Describe the solution you'd like
This was talked about in an issue #1478 (comment). To summarize:

Describe alternatives you've considered
For the CONTRIBUTING.md page, it was proposed to link it or convert it into .rst. However, it is required for it to stay as an .md file to fit GitHub's Community Guidelines.

Additional context
Please see #1478 (comment) and #1478 (comment) for further context 😸

@bmcfee bmcfee added the documentation Issues relating to docstrings, examples, and documentation build label Jan 30, 2024
@bmcfee bmcfee added this to the 0.10.2 milestone Mar 12, 2024
@bmcfee bmcfee removed this from the 0.10.2 milestone May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues relating to docstrings, examples, and documentation build
Development

No branches or pull requests

2 participants