docs: show the browser viewer and the community channels - #316
Conversation
- 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).
There was a problem hiding this comment.
💡 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".
| 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 |
There was a problem hiding this comment.
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 Report✅ All modified and coverable lines are covered by tests. @@ 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:
|
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):
docs-checknow requires the two new sections in both mirrors.Website (
docs/site/):reference/community.md);public/community/and is the same file the pt-tools and Voltip sites show.firlab's shell gained the
QrCodecomponent and the/community/asset checks in fix(site): 文档站搜索按钮的可访问名称与可见文字一致,pt-tools 隐私卡片恢复网格 firlab#33. The sidebarentry comes with the next sync.
Quick start, step 5: the table of commands becomes the real output of
search,callers,calleesandimpact, 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
make pre-ci) passed on this head: docs-check OK on 62 Markdown files, all Rust tests and569 frontend tests.
mainshell, then the site was built and checked:check-dist.shpassed with 26 Chinese and 25 English pages;/codegraph/resolve, 395 of them with a fragment;against the published v0.53.3 before the merge.
🤖 Generated with Claude Code