-
Notifications
You must be signed in to change notification settings - Fork 339
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
Change directory of contributor guide to better match its name (with redirects) #1605
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1605 +/- ##
=======================================
Coverage 97.21% 97.21%
=======================================
Files 83 83
Lines 7961 7961
=======================================
Hits 7739 7739
Misses 222 222 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we just delete docs/contributing/workflow.rst
? If I remember correctly, it was only created as part of a demo for the 2021 hack week. I don't see why we should retain it. Especially since it's not referenced anywhere in the rest of the documentation.
Agreed. I keep meaning to work on this but too many other things keep coming up...sigh! |
We did this as an example during Plasma Hack Week 2021, but never got around to finishing it. We can restore it later on.
The directory name
docs/development
came from the name "Development Guide", which was later changed to "Contributor Guide". This PR renames the directory todocs/contributing
to better match the new name.I also used the sphinx-reredirect extension to set up redirects. This looks like a really helpful extension since we'll probably end up changing the names of pages again in the future too.