fix(docs): resolve markdownlint errors#8
Conversation
|
You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool. What Enabling Code Scanning Means:
For more information about GitHub Code Scanning, check out the documentation. |
There was a problem hiding this comment.
💡 Codex Review
This new Markdown file contains embedded NUL characters before the sample ADR numbers, which makes Git treat it as binary and leaves control characters in the rendered text. Since CI and future reviewers expect docs/**/*.md to be normal UTF-8 Markdown, remove those NUL bytes so the ADR README can be linted, diffed, and rendered as text.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| push: | ||
| branches: | ||
| - main | ||
| - master |
There was a problem hiding this comment.
Avoid adding a second Pages deploy on main pushes
On main, this new workflow is triggered by the same event as the existing Pages workflow in .github/workflows/static.yml, and both upload/deploy to the github-pages environment with the same pages concurrency group. When a push lands, whichever workflow runs last can overwrite the other artifact (docs vs ./site), so the published site can flip between the old static HTML and the MkDocs build; remove or retarget one of the deploy workflows.
Useful? React with 👍 / 👎.
| @@ -0,0 +1,62 @@ | |||
| site_name: cloud-security-service-model Documentation | |||
| site_description: Autonomous GitHub workflow engine for the Coding Autopilot System. | |||
| site_url: https://Coding-Autopilot-System.github.io/gsd-orchestrator/ | |||
There was a problem hiding this comment.
Point MkDocs site_url at this repository
The Pages workflow added in this commit builds this repository's MkDocs site, but site_url still points at gsd-orchestrator. MkDocs uses site_url for generated absolute metadata such as canonical URLs and sitemaps, so the published cloud-security-service-model docs will advertise the wrong project URL; set it to this repo's Pages URL or omit it until the URL is known.
Useful? React with 👍 / 👎.
Automated sweep to fix markdownlint errors (MD058, MD060, MD013) across the docs directory.