chaoss
Current maintainers list in RST docs is out of date with the markdown version
[issue] noticed that the “Current Maintainers” listed in index.rst (ReadTheDocs) does not match the correct list in CONTRIBUTORS.md and also the contributors of 2025 not updated in index.rst
in CONTRIBUTORS.md.
Current Maintainers
- Sean P. Goggins — @sgoggins
- Adrian Edwards — @MoralCode
- Andrew Brain — @ABrain7710
- Isaac Milarsky — @IsaacMilarky
- John McGinness — @Ulincys
BUT IN index.rst Current maintainers
Derek Howard <https://github.com/howderek>_Andrew Brain <https://github.com/ABrain7710>_Isaac Milarsky <https://github.com/IsaacMilarky>_John McGinnes <https://github.com/Ulincys>_Sean P. Goggins <https://github.com/sgoggins>_
Originally posted by @iGufrankhan in #3442
I think the best resolution to this is to pick one of the options and refer the other one to it.
I think having the markdown be the canonical source for maintainers (as thats probably a technical-adjacent thing that users may care less about than contributors/developers). This would therefore start to create a pattern of "markdown is internal dev docs, RST is user-facing docs"
Hi! I’m a new contributor and I’d like to help with this issue.
From the discussion, it seems the proposed resolution is to make CONTRIBUTORS.md the canonical source for maintainers and update index.rst accordingly (or refer to it), keeping a clear separation between developer-facing markdown docs and user-facing RST docs.
Before I proceed, could you please confirm:
- Whether this issue is fully resolved by the linked PRs, or
- If there are still changes needed (for example, updating 2025 contributors or aligning the maintainer list)?
Once confirmed, I’d be happy to take this up. Thank you!
On mobile currently but I think theres at least one open PR that addresses this, although feel free to look at the existing feedback and submit a better version if you think you can do it better than the existing efforts
Hi maintainers, I’m a student new to Augur and open source contributions. I’ve read the docs and contributing guidelines, and I’d like to work on updating 'Current Maintainers' in index.rst as mentioned in this issue. Please let me know if this is ok and if there’s anything specific you’d like me to follow. Thanks!
On mobile currently but I think theres at least one open PR that addresses this, although feel free to look at the existing feedback and submit a better version if you think you can do it better than the existing efforts
Thanks for the update! I’ll focus on wrapping up my current documentation PR and will check back here later if there’s still work needed.