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

Create a script to open PRs for READMEs on packages with package wiki page content #103

Open
tfoote opened this issue Oct 26, 2018 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@tfoote
Copy link
Member

tfoote commented Oct 26, 2018

With index.ros.org coming online It would be good to create README files with the wiki content for each package to make it available on rosindex and be closer tied to the code.

If we just open PRs for this the maintainer can choose to accept, edit or modify the content, or just reject it.

@dirk-thomas
Copy link
Member

I assume this is referring to existing ROS 1 packages wiki pages? The proposal sounds like a drastic change in policy where we recommend documentation to be. Before developing tooling around this it might be good to first discuss the pros and cons of this approach and establish a "new policy" if decided.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants