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

Add the ability to render README from the package root #261

Open
tfoote opened this issue Oct 26, 2018 · 0 comments
Open

Add the ability to render README from the package root #261

tfoote opened this issue Oct 26, 2018 · 0 comments

Comments

@tfoote
Copy link
Member

tfoote commented Oct 26, 2018

As we're adding index.ros.org support which will render README files from packages. It would be good to support rendering READMEs for packages on the wiki too. This will allow the package README to be authoritative and rendered in both locations.

To make this happen the package header could be extended to remotely load the README from github's raw API if it exists.

This would complement ros-infrastructure/rosindex#103

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant