Skip to content

Link Endor Labs documentation from the README - #108

Merged
VaishArun merged 6 commits into
mainfrom
readme-docs-links
Nov 11, 2026
Merged

VaishArun merged 6 commits into
mainfrom
readme-docs-links

Conversation

@VaishArun

@VaishArun VaishArun commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Why

A citation baseline run found that this README has no links to docs.endorlabs.com at all. Readers who land here, and the AI assistants that cite this page, have no path from the README to the documentation for anything it describes.

One correction to how this was originally framed. The baseline report justified this change as redirecting SEO authority to the docs. That mechanism does not work: GitHub renders every external link in a README with rel="nofollow", so these links pass no PageRank. The real benefit is narrower and worth stating honestly:

  • Readers of the README get a path to the documentation they currently do not have.
  • The canonical docs URLs now appear as text in a heavily indexed, high-authority page, which helps assistants cite the right URL on the right host. That is directly relevant to the baseline finding, where assistants cited a mirror host and two dead archive hosts.

This does not fix the broken citations themselves. That needs the TLS certificate on docs.api.endorlabs.com and the removal of the docs-archive DNS records, neither of which lives in a repository.

What changed

Contextual links only. No wording about product behavior was changed, and no parameter descriptions were touched.

  • Each capability bullet in the intro links to the page for that scan type (AI SAST, secrets, SCA and reachability, malware, AI models, containers, GitHub Actions and CI/CD tooling, RSPM).
  • The intro paragraph links PR scans, PR comments, and SARIF export to GitHub Advanced Security.
  • A new Documentation section links the GitHub Actions setup page, the keyless authentication page, and the endorctl CLI reference.
  • The prerequisites and usage steps link keyless authentication, API keys, and authorization policies.
  • Each parameter table now points at the reference documentation behind its inputs, including the endorctl scan reference, the environment variables reference, and artifact signing.

Verification

All 22 documentation URLs return 200 directly, checked without following redirects. Each link target was checked against the page it points to, so the link text matches the page subject.

The second commit fixes a defect in the first. docs.endorlabs.com canonicalizes without a trailing slash, declares self-referencing canonical tags in that form, and returns 308 for the slashed form. The links initially carried trailing slashes, making each one a redirect hop to the canonical URL rather than a direct hit on it.

🤖 Generated with Claude Code

VaishArun and others added 2 commits November 11, 2026 14:15
The action README carried no links to docs.endorlabs.com. This repository
is our highest-authority indexed asset on scanning topics and it collects
inbound links from every customer repository that uses the action, so the
missing links are authority we already have but do not pass on to the
documentation.

Adds contextual links only. No claims about product behavior change:

- Each capability bullet links to the page for that scan type.
- The intro paragraph links PR scans, PR comments, and SARIF export.
- A new Documentation section links the GitHub Actions setup page, the
  keyless authentication page, and the endorctl CLI reference.
- The prerequisites link keyless authentication, API keys, and
  authorization policies.
- Each parameter table points at the reference docs behind its inputs.

All 22 URLs were checked and return 200 on docs.endorlabs.com.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
docs.endorlabs.com canonicalizes without a trailing slash. Every page
declares a self-referencing canonical tag with no trailing slash, and
requesting the slashed form returns 308 to the unslashed one.

The links added in the previous commit all carried a trailing slash, so
each one was a redirect hop rather than a direct hit on the canonical
URL. For a change whose point is to send readers and crawlers to the
canonical URL, that was the wrong form.

All 22 URLs now return 200 directly, verified without following
redirects.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@VaishArun
VaishArun requested review from nrynss and peter-cg November 11, 2026 08:56
peter-cg and others added 4 commits November 11, 2026 08:50
The basic-validation audit step started failing on new advisories against
locked transitive deps. yarn 1 ignores --audit-level and exits non-zero on
any finding, so all of them need clearing:

- undici >=8.12.2 (high: cache poisoning, TLS bypass, DoS)
- fast-xml-parser >=5.12.0 (low)
- minimatch >=11.0.1 (moderate, via readdir-glob and glob)
- glob >=14.0.2 for archiver-utils only (moderate). Scoped with
  **/archiver-utils/glob so the jest/rimraf glob@7/10 stay put; even the
  latest archiver-utils still pins glob@^10.

dist/ is rebuilt and .licenses/ is re-cached. glob 14 is BlueOak-1.0.0 per
package.json, but licensee reads its LICENSE.md as "other", so it is listed
under reviewed in .licensed.yml.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Second part of the dependency bump commit. One createCommitOnBranch call
cannot carry every rebuilt bundle, so they are split across commits.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Second part of the dependency bump commit. One createCommitOnBranch call
cannot carry every rebuilt bundle, so they are split across commits.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Second part of the dependency bump commit. One createCommitOnBranch call
cannot carry every rebuilt bundle, so they are split across commits.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@VaishArun
VaishArun merged commit e46f6e3 into main Nov 11, 2026
4 checks passed
@VaishArun
VaishArun deleted the readme-docs-links branch November 11, 2026 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants