Conversation
The README linked into `docs/` by file path. Those links work when reading the repository on GitHub and nowhere else: they are dead in the rendered crate description, in anything that mirrors the README, and in a checkout without the documentation source. Every one of them now points at https://lorem-dev.github.io/doppel/, where the same page is published -- verified by fetching all six. The two remaining `docs/` references are not documentation links: the logo asset, and the source directory named by the local `mkdocs serve` instruction.
docs: point the README at the published documentation
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.
Automated back-merge of
mainintodevelop.Latest commit on main:
08a0824-- Merge pull request #3 from lorem-dev/feature/readme-doc-linksOpened by
Back-merge main -> develop, run30765016775.Merge this (or turn on auto-merge) to keep
developin step withmain. Resolve any conflicts here rather than on develop.