Skip to content

docs: fix stale claims that Go is unsupported/roadmap-only#14

Merged
Krishan27 merged 1 commit into
mainfrom
docs/fix-stale-go-unsupported-claims
Jul 6, 2026
Merged

docs: fix stale claims that Go is unsupported/roadmap-only#14
Krishan27 merged 1 commit into
mainfrom
docs/fix-stale-go-unsupported-claims

Conversation

@flaglint

@flaglint flaglint commented Jul 6, 2026

Copy link
Copy Markdown
Owner

Summary

  • flaglint-go shipped (v0.1.0/v0.1.1) as a real, separate CLI — these pages still said Go SDK usage was entirely unsupported/roadmap-only via a tree-sitter-go plan that was never actually built.
  • supported-scope.md: split the "Go, Java, Python..." row — Go now points to flaglint-go's own supported-scope page.
  • safety-model.md: clarified this page is specifically about flaglint-js's migrate --apply (which flaglint-go doesn't have), not a blanket "Go unsupported by FlagLint" statement.
  • changelog.md: updated the ADR 006 (Go language support, PROPOSED) entry to note it was superseded by flaglint-go, built on native go/parser instead of the originally-proposed tree-sitter-go.

⚠️ Do not merge before the Go docs section PR

This links to a new /docs/go/ section that doesn't exist yet (landing in a follow-up PR). Since deploy.yml pushes straight to Cloudflare Pages on merge to main, merging this alone would put live 404 links on the site. Merge the Go docs section PR first, then this one.

Test plan

  • npm run build — clean, no errors
  • Reviewed diff for accuracy against actual flaglint-go capabilities

Summary by CodeRabbit

  • Documentation
    • Clarified the safety model and supported-scope docs to distinguish JavaScript/TypeScript workflows from Go tooling.
    • Updated coverage guidance so Go is called out separately, and other SDKs are clearly marked as unsupported.
    • Expanded the changelog entry for Go language support with the later implementation details and a link to the Go documentation.

flaglint-go shipped (v0.1.0/v0.1.1) as a separate, real CLI months after
these pages were written — they still said Go SDK usage was entirely
unsupported/roadmap-only via a tree-sitter-go plan that was never built.

- supported-scope.md: split the "Go, Java, Python..." row; Go now points to
  flaglint-go's own supported-scope page instead of being lumped in with
  genuinely-unsupported languages.
- safety-model.md: clarified this page is specifically about flaglint-js's
  migrate --apply (which flaglint-go doesn't have), not a blanket "Go is
  unsupported by FlagLint" statement.
- changelog.md: updated the ADR 006 (Go language support, PROPOSED) entry to
  note it was superseded — Go support shipped as flaglint-go, built on
  native go/parser instead of the originally-proposed tree-sitter-go.

Links to the new /docs/go/ section (landing in a follow-up PR) — the actual
Go docs content doesn't exist yet, so those links 404 until that PR merges.

Signed-off-by: Krishan Kant Sharma <krishansharma0327@gmail.com>
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying flaglint with  Cloudflare Pages  Cloudflare Pages

Latest commit: 79794b3
Status: ✅  Deploy successful!
Preview URL: https://82f08f29.flaglint.pages.dev
Branch Preview URL: https://docs-fix-stale-go-unsupporte.flaglint.pages.dev

View logs

@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Documentation updates clarify that the safety-model and supported-scope pages apply specifically to the flaglint-js (JavaScript/TypeScript) CLI, separating Go SDK coverage into the flaglint-go project. The changelog entry for ADR 006 is updated to reflect the actual shipped Go implementation approach.

Changes

Docs scope clarification

Layer / File(s) Summary
Safety model doc scope clarification
src/content/docs/docs/concepts/safety-model.md
Intro text clarifies the migrate --apply safety model applies to flaglint-js only; the SDK rewrite table separates Go SDK into its own row pointing to flaglint-go docs.
Supported scope doc split for Go SDK
src/content/docs/docs/reference/supported-scope.md
Intro text scopes the page to flaglint-js; the coverage table splits the combined Go/Java/Python row into a dedicated Go SDK row (pointing to flaglint-go) and a remaining unsupported Java/Python/other row.
Changelog update for Go support history
src/content/docs/docs/reference/changelog.md
ADR 006 changelog entry expanded to note the tree-sitter design was superseded, describing the shipped flaglint-go implementation based on Go's native parser/AST.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly reflects the doc updates correcting stale claims about Go being unsupported or roadmap-only.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/fix-stale-go-unsupported-claims

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/content/docs/docs/concepts/safety-model.md`:
- Around line 4-8: The safety-model docs page currently links to a Go docs
target that does not exist in this change, so update the content in the
safety-model markdown to avoid shipping dead `/docs/go/...` links. Gate or defer
the Go documentation reference in this page until the Go docs subtree is part of
the same PR, and apply the same treatment to the later Go docs link(s)
referenced in the file so both `flaglint-go` mentions only point to existing
pages.

In `@src/content/docs/docs/reference/changelog.md`:
- Around line 78-83: The changelog entry in the ADR 006 section should not
publish a broken internal link to the nonexistent Go docs page. Update the
markdown in the changelog to either remove the `/docs/go/` link or replace it
with a non-link placeholder until the target page exists, keeping the
surrounding text in the same `ADR 006 — Go language support` entry.

In `@src/content/docs/docs/reference/supported-scope.md`:
- Around line 4-8: The supported-scope doc currently links to the Go docs before
those routes exist, causing broken navigation. Update the content in the
supported-scope page so the Go CLI reference link is gated or omitted until the
Go docs section is actually added, using the existing supported-scope page
content as the place to adjust the cross-link.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 72a39ec3-5fa3-4875-8731-eac33f02857a

📥 Commits

Reviewing files that changed from the base of the PR and between c16d7d5 and 79794b3.

📒 Files selected for processing (3)
  • src/content/docs/docs/concepts/safety-model.md
  • src/content/docs/docs/reference/changelog.md
  • src/content/docs/docs/reference/supported-scope.md

Comment on lines +4 to +8
lastUpdated: 2026-07-06
---

This page covers **flaglint-js**'s `migrate --apply` rewrite safety model, which is specific to the JavaScript/TypeScript CLI — flaglint-go does not have an automated migration/rewrite command (audit, scan, and validate only). See [flaglint-go's concepts docs](/docs/go/concepts/identity-model/) for the Go CLI's own safety guarantees.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf 'Root files mentioning the Go concepts path:\n'
rg -n "/docs/go/concepts/identity-model/|flaglint-go's concepts docs|concepts/identity-model" src content docs . --glob '!**/node_modules/**' || true

printf '\nCandidate files under docs:\n'
git ls-files 'src/content/docs/**' | sed -n '1,200p'

printf '\nCheck whether the referenced Go docs file exists:\n'
fd -a 'identity-model\.md$|identity-model/index\.md$' src/content/docs content/docs docs 2>/dev/null || true
fd -a 'safety-model\.md$' src/content/docs content/docs docs 2>/dev/null || true

Repository: flaglint/flaglint.dev

Length of output: 3885


🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "Safety model excerpt:"
cat -n src/content/docs/docs/concepts/safety-model.md | sed -n '1,120p'

echo
echo "Find any Go docs files in this subtree:"
git ls-files 'src/content/docs/go/**' 'src/content/docs/docs/go/**' | sed -n '1,200p'

echo
echo "Search for the referenced route in the repo:"
rg -n --hidden --glob '!**/node_modules/**' --glob '!**/.git/**' "/docs/go/concepts/identity-model/|identity-model" src/content/docs

Repository: flaglint/flaglint.dev

Length of output: 10234


Gate the Go docs links on the Go docs section PR. The /docs/go/... target isn’t present here, so this page would ship a dead link unless the Go docs subtree lands with it. Also applies to lines 50-51.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/content/docs/docs/concepts/safety-model.md` around lines 4 - 8, The
safety-model docs page currently links to a Go docs target that does not exist
in this change, so update the content in the safety-model markdown to avoid
shipping dead `/docs/go/...` links. Gate or defer the Go documentation reference
in this page until the Go docs subtree is part of the same PR, and apply the
same treatment to the later Go docs link(s) referenced in the file so both
`flaglint-go` mentions only point to existing pages.

Comment on lines +78 to +83
- **ADR 006 — Go language support** (PROPOSED, later superseded) —
tree-sitter-go parser design, import tracing for `go-server-sdk`, go.mod
boundary handling, 6-phase plan. Go support ultimately shipped as a
separate project, [flaglint-go](https://github.com/flaglint/flaglint-go),
built around Go's native `go/parser`/`go/ast` instead of tree-sitter — see
[flaglint-go's docs](/docs/go/).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

git ls-files src/content/docs | sed -n '1,200p'

Repository: flaglint/flaglint.dev

Length of output: 2830


🏁 Script executed:

rg -n --hidden --glob '!node_modules' --glob '!dist' --glob '!build' '/docs/go/|flaglint-go|Go language support|go/parser|go/ast' src/content/docs

Repository: flaglint/flaglint.dev

Length of output: 1646


🏁 Script executed:

git ls-files | sed -n '1,200p'

Repository: flaglint/flaglint.dev

Length of output: 3564


🏁 Script executed:

sed -n '1,220p' public/_redirects && printf '\n---\n' && sed -n '1,240p' src/content.config.ts && printf '\n---\n' && sed -n '1,220p' astro.config.mjs

Repository: flaglint/flaglint.dev

Length of output: 7216


Hold the /docs/go/ link for now
src/content/docs/docs/reference/changelog.md:83 points to a page that doesn’t exist in this site yet, so this changelog entry would publish a 404.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/content/docs/docs/reference/changelog.md` around lines 78 - 83, The
changelog entry in the ADR 006 section should not publish a broken internal link
to the nonexistent Go docs page. Update the markdown in the changelog to either
remove the `/docs/go/` link or replace it with a non-link placeholder until the
target page exists, keeping the surrounding text in the same `ADR 006 — Go
language support` entry.

Comment on lines +4 to +8
lastUpdated: 2026-07-06
---

This page covers **flaglint-js**, the JavaScript/TypeScript CLI. For the Go CLI's supported scope, see [flaglint-go: Supported Scope](/docs/go/reference/supported-scope/).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Map the docs-related files and routes.
git ls-files | rg '^(src/content/docs|astro|docs|src/pages|src/content).*$'

# Look for references to the Go docs base path and supported-scope page.
rg -n "/docs/go/|supported-scope|flaglint-go" src/content docs astro src/pages . 2>/dev/null || true

Repository: flaglint/flaglint.dev

Length of output: 6898


🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Inspect the docs collection and any routing/redirects for a Go docs section.
sed -n '1,220p' astro.config.mjs
printf '\n--- src/content.config.ts ---\n'
sed -n '1,220p' src/content.config.ts
printf '\n--- public/_redirects ---\n'
sed -n '1,120p' public/_redirects 2>/dev/null || true

printf '\n--- go docs files ---\n'
fd -t f '.*' src/content/docs | rg '/go/'

Repository: flaglint/flaglint.dev

Length of output: 7287


Gate the Go docs links until that section exists.
/docs/go/ and /docs/go/reference/supported-scope/ aren’t routed in this site yet, so they’ll 404 until the Go docs pages land.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/content/docs/docs/reference/supported-scope.md` around lines 4 - 8, The
supported-scope doc currently links to the Go docs before those routes exist,
causing broken navigation. Update the content in the supported-scope page so the
Go CLI reference link is gated or omitted until the Go docs section is actually
added, using the existing supported-scope page content as the place to adjust
the cross-link.

@Krishan27 Krishan27 merged commit 79794b3 into main Jul 6, 2026
4 checks passed
@Krishan27 Krishan27 deleted the docs/fix-stale-go-unsupported-claims branch July 6, 2026 19:50
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.

2 participants