Document that new pages should be linked to from the global nav #599
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicksnyder
approved these changes
Feb 21, 2020
handbook/documentation/index.md
Outdated
| @@ -12,7 +12,10 @@ We use the [monthly release blog post](https://about.sourcegraph.com/blog) as a | |||
|
|
|||
| ## Naming and linking documentation pages | |||
|
|
|||
| 1. There is no global index or nav, so all docs should be linked from their parent index page. Every new document should be cross-linked to its related documentation, and linked from its topic-related index, when it exists. | |||
| 1. All docs should be linked to from their parent index page. | |||
There was a problem hiding this comment.
What exactly do you mean by this? Every page in the current directory should be linked to in the first index.md in the directory hierarchy?
There was a problem hiding this comment.
I've changed this to plain language largely inspired by your question.
nicksnyder
reviewed
Feb 21, 2020
| 1. All docs should be linked to from their parent index page. | ||
| 1. Every new document should be: | ||
| - Cross-linked to its related documentation, and linked from its topic-related index, when it exists. | ||
| - Linked to from the [docs global nav template](https://github.com/sourcegraph/sourcegraph/blob/master/doc/_resources/templates/document.html#L58). |
There was a problem hiding this comment.
It is unclear which parts of this document apply to product documentation, handbook documentation or both. This line item is the former I think. Can we clarify this more?
There was a problem hiding this comment.
I'm addressing this in #600 (comment)
nicksnyder
approved these changes
Feb 24, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.