chore: fix docs sync — GitHub Actions link + drop repo-maintenance pointer#203
Merged
Conversation
…inter Two corrections after `docs/github-actions.md` was moved under a nested `github-actions/` group on the website: - Rewrite the `github-actions.md` link in about.md, installation.md, and quickstart.md to `github-actions/about.md` during sync. Without this, the synced pages ship broken relative links that the website link-checker rejects. - Delete the "For repository-side maintenance notes..." paragraph from `docs/github-actions.md`. That pointer targeted contributors reading the repo; contributors will find `docs/github-actions-maintenance.md` on their own since it sits next to `docs/github-actions.md` in the same directory. Removing it from the source keeps the repo view and the website view identical and avoids a fragile sync-time regex.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Two corrections to the docs synced into
dash0hq/dash0-website, after the recent move ofdocs/github-actions.mdunder a nestedgithub-actions/group on the website:docs/about.md,docs/installation.md, anddocs/quickstart.mdall link togithub-actions.md. Since the sync now mapsdocs/github-actions.md→github-actions/about.md, that relative link resolves to/docs/.../github-actionson the website (no page) rather than/docs/.../github-actions/about. Added per-filereplace-regextransformations that rewrite the link during sync. This resolves the check-links failure on dash0-website PR #607.docs/github-actions.mdpointed atdocs/github-actions-maintenance.md, which is contributor-facing content. Cursor Bugbot flagged it as internal implementation detail leaking into customer docs. Deleting the paragraph from the source (rather than stripping it via a sync transformation) keeps the repo view and the website view identical, and avoids a fragile regex that would break on any future wording change. Contributors browsingdocs/will still findgithub-actions-maintenance.mdon their own — it sits right next togithub-actions.md.