-
Notifications
You must be signed in to change notification settings - Fork 213
Conversation
CONTRIBUTING.md
Outdated
@@ -9,7 +9,7 @@ community. | |||
### Participation Conduct | |||
|
|||
In order to ensure everyone has a fair, pleasant, and inclusive experience contributing to Neutrino, we ask that you | |||
abide by our [community participation guidelines](/contributing/code-of-conduct.md), based on the | |||
abide by our [community participation guidelines](/docs/contributing/code-of-conduct.md), based on the |
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.
Links for gitbook have to be relative in order for them to work on the docs site as well as github. Change to: ./code-of-conduct.md
.
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.
@eliperelman /docs/contributing/README.md
is the file that the gitbook reads and in there the paths are relative. Is CONTRIBUTING.md
also read by the gitbook? I don't see that link in /docs/SUMMARY.md
.
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.
CONTRIBUTING.md in the repo root maps to docs/contributing/README.md
in the docs.
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.
So to answer your question better, CONTRIBUTING.md is not read by gitbook, it uses contributing/README.md which is the same thing.
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.
I see, sounds good. Changed it back to relative paths
CONTRIBUTING.md
Outdated
@@ -61,7 +61,7 @@ possible. | |||
## Getting started | |||
|
|||
Most contributions will involve working with the neutrino-dev codebase. Please refer to the [development | |||
documentation](/contributing/development.md) for technical details on getting started. | |||
documentation](/docs/contributing/development.md) for technical details on getting started. |
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.
Links for gitbook have to be relative in order for them to work on the docs site as well as github. Change to: ./development.md
.
The links don't seem to have been fixed. Does it work for you @eliperelman? |
The docs haven't been deployed since master points to the v5 docs, and we can't deploy until we publish v5. |
Sounds good. |
No description provided.