Repository navigation
docs(site): point Docs links at README - #127
Merged
Merged
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
The landing page's two Docs links ("Docs" in the nav and the "Read the docs" button) now point to the repository README (
https://github.com/brenpike/Chatter.Rest.Hal#readme). They previously pointed to thedocs/folder.The README contains the quick start, builder and deserialization guides, and examples. The
docs/folder is mostly internal design notes, so visitors who landed there had no clear place to start.Changes
site/index.src.html: twohrefvalues changed. The link text is the same.site/index.html: regenerated withnode build.js. The output is byte-identical across two rebuilds, which is what the Pages workflow's verification step checks.Nothing on the page looks different; only the link targets changed.
Validation
dotnet build -c Release: 0 errors.dotnet test -c Release: 456/456 and 51/51 passed.git diff: 4 changed lines, allhref-only.tree/main/docsno longer appears in either file.Versioning
None.
site/**is not a package bump-trigger path.