Skip to content

docs(ui): describe this repository's frontend and keep its bundle out of local indexes #305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sunerpy merged 1 commit into from
Oct 3, 2026
Merged

docs(ui): describe this repository's frontend and keep its bundle out of local indexes #305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,21 @@ a second positional argument to a research command. If the index is unavailable,
follow `status` recovery guidance; do not initialize or rebuild unless requested
or required by that guidance.

The committed viewer bundle in `crates/codegraph-ui/viewer/` is minified
`make ui` output. Indexed, it adds about 3,300 symbols, nine in ten of them with
one- or two-letter names, that crowd the most-depended-on and entry-point lists,
Comment on lines +38 to +39

@chatgpt-codex-connector chatgpt-codex-connector Bot Oct 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Derive the viewer counts instead of freezing them

Whenever make ui rebuilds the minified bundle, both the symbol count and short-name ratio can change, but no source-contract test or documentation check derives or verifies these values—the only repository occurrence is this prose. Consequently the canonical contributor guide can silently retain obsolete evidence; either omit the numeric claims or derive and pin them in scripts/docs-check.py or a product test.

AGENTS.md reference: AGENTS.md:L134-L136

Useful? React with 👍 / 👎.

and every name it shares with real code lowers that name's exact-match
confidence. Keep it out of a local index with `.codegraph/config.toml`, which is
local and never committed; `codegraph sync .` (or a running daemon) applies it:

```toml
[app]
name = "codegraph-rust"

[indexing]
exclude = ["crates/codegraph-ui/viewer/"]
```

## Hard invariants

1. **Deterministic graph output.** Identical source and configuration must produce
Expand Down
10 changes: 10 additions & 0 deletions docs/upstream-sync/UPSTREAM.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,16 @@ below remain immutable historical evidence.

## Sync log

### 2026-10-03 — `ui/README.md` rewritten for this repository

The imported frontend README described upstream's npm monorepo: its build, the
`@colbymchenry/codegraph-ui` package and its publishing, and engine files under
`src/`. It now describes this repository: `make ui` and `make ui-check`, the
committed bundle the crate embeds, the Rust files behind the server and the
engine, and what the Rust server does not send yet. Its frontend-design sections
are upstream's, with their paths, numbers and claims checked against this tree.
A later sync of upstream `ui/` keeps this README rather than taking upstream's.

### 2026-10-03 — browser viewer RESTYLED: direction D, a local design layer

The ported viewer's frontend now carries the design the owner selected
Expand Down
Loading
Loading