Skip to content

docs: show the browser viewer and the community channels - #316

Merged
sunerpy merged 1 commit into
mainfrom
docs/viewer-community
Oct 3, 2026
Merged

sunerpy merged 1 commit into
mainfrom
docs/viewer-community

Conversation

@sunerpy

@sunerpy sunerpy commented Oct 3, 2026

Copy link
Copy Markdown
Owner

Summary

This makes the landing pages and the website present the browser viewer and the community channel, ahead of promoting
CodeGraph.

  • READMEs (English and Chinese, kept as mirrors):

    • a viewer capture under the header, switching with the reader's theme;
    • a Visual (preview) point in Why CodeGraph;
    • a Browser viewer section: how to start it, what it reads and writes, and the Flow and Map views;
    • a Community section: GitHub Issues and the WeChat Official Account 六月水蓝, with its QR code;
    • the website (firlab.app/codegraph) in the documentation list and the header links.

    docs-check now requires the two new sections in both mirrors.

  • Website (docs/site/):

    • a community page in both languages (reference/community.md);
    • the Official Account's QR code on both home pages;
    • the image lives in public/community/ and is the same file the pt-tools and Voltip sites show.

    firlab's shell gained the QrCode component and the /community/ asset checks in fix(site): 文档站搜索按钮的可访问名称与可见文字一致,pt-tools 隐私卡片恢复网格 firlab#33. The sidebar
    entry comes with the next sync.

  • Quick start, step 5: the table of commands becomes the real output of search, callers, callees and
    impact, now that the kind column is padded (fix(cli): pad the kind column in search, callers, callees and impact #314).

Merge after v0.53.3 is published. The quick start's output is the v0.53.3 layout; v0.53.2 still prints the
columns run together.

Verification

  • The pre-push gate (make pre-ci) passed on this head: docs-check OK on 62 Markdown files, all Rust tests and
    569 frontend tests.
  • firlab's sync script ran on these pages against firlab's main shell, then the site was built and checked:
    • the contracts held: both languages, registered components, word lists and asset existence;
    • check-dist.sh passed with 26 Chinese and 25 English pages;
    • 516 links under /codegraph/ resolve, 395 of them with a fragment;
    • the QR code is on both home pages and both community pages.
  • The quick-start output was pasted from the fix(cli): pad the kind column in search, callers, callees and impact #314 build, run on the sample in the page. It is re-checked
    against the published v0.53.3 before the merge.

🤖 Generated with Claude Code

- READMEs (both languages): a viewer capture under the header, a "Visual
  (preview)" point, a Browser viewer section with the Flow and Map views, a
  Community section with GitHub Issues and the WeChat Official Account 六月水蓝,
  and the website in the documentation list. docs-check now requires the two
  new sections in both mirrors.
- Website: a community page in both languages and the Official Account's QR
  code on both home pages (public/community/, the same image as the pt-tools
  and Voltip sites).
- Quick start: step 5 shows the real output of search, callers, callees and
  impact, now that the kind column is padded (#314).

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 52b06cb75a

ℹ️ 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".

Comment thread README.md
Comment on lines +267 to +268
It binds `127.0.0.1` only, never builds or changes the index, and writes nothing but
the trails you choose to save under `.codegraph/ui/trails/`. It has a dark and a light

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Qualify the default trail path

When CODEGRAPH_DIR selects another index directory—or for a fresh project on a Windows drive under WSL, where the default can be .codegraph-wsl—trails are written under that resolved index root rather than .codegraph/ui/trails/. This absolute claim can therefore send users auditing the viewer's filesystem writes to the wrong directory; describe the location as <index root>/ui/trails/ and update the mirrored Chinese statement as well.

AGENTS.md reference: AGENTS.md:L135-L139

Useful? React with 👍 / 👎.

@codecov

codecov Bot commented Oct 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #316   +/-   ##
=======================================
  Coverage   95.07%   95.08%           
=======================================
  Files         198      198           
  Lines      109014   109014           
=======================================
+ Hits       103647   103652    +5     
+ Misses       5367     5362    -5     

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@sunerpy
sunerpy merged commit 79eae25 into main Oct 3, 2026
19 of 21 checks passed
@sunerpy
sunerpy deleted the docs/viewer-community branch October 3, 2026 19:17
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.

1 participant