Skip to content

docs: refresh agent guide and docs to HEAD; add decisions and open questions - #671

Merged
dvCodeWorld merged 4 commits into
stagefrom
cursor/proxy-ui-add-the-agent-guide-and-docs-to-this-repository-written-fro-eafb
Nov 3, 2026
Merged

dvCodeWorld merged 4 commits into
stagefrom
cursor/proxy-ui-add-the-agent-guide-and-docs-to-this-repository-written-fro-eafb

Conversation

@harshhsahu

Copy link
Copy Markdown
Collaborator

Docs only. No code changes.

The repo already had AGENTS.md and a verified docs/ set (as of 76f26ae5). This PR updates those docs in place rather than replacing them, brings them up to 395659d5, and adds the two docs that were missing.

Changes

  • Refreshed for code merged since the last verification (PRs P0092 | 36Blocks | Issue while connecting docstar through claude #663–P0095 | Provide client an option to choose between different redirect response modes #667):
    • Block client secrets (features/:id/clientSecrets, at most 2 active, plaintext shown once, revoke keeps history)
    • The legacy / code redirect response mode. The dashboard sends it only when it changes, and code needs an active secret.
    • OAuth consent: only the clicked button shows a spinner, and the redirect now uses window.location.replace.
    • Docs touched: modules/panel-features.md, flows/feature-configuration.md, api.md, ui/state.md, glossary.md, modules/widget-auth.md, flows/widget-verification.md.
  • New docs/decisions.md: the cross-cutting design decisions, each with its evidence (code, comments, commits, or removed docs in history).
  • New docs/open-questions.md: every question the code can't answer, linked to the doc that holds the detail. Includes two new ones about code mode and who may manage client secrets.
  • docs/README.md: maps the standard names (ARCHITECTURE, FLOWS, CONFIGURATION, DECISIONS, OPEN_QUESTIONS) to the existing lower-case files. This keeps one source of truth per topic and avoids ARCHITECTURE.md and architecture.md clashing on case-insensitive file systems.
  • Two TODOs answered from evidence:
    • CI "Build check" fails on every PR. 95 of the last 100 runs failed; the last green run was on 2026-04-23. The error is TS2307: Cannot find module './env-variables'. Recorded in environment.md, conventions.md and AGENTS.md.
    • The "new version" banner never fires. A local production build emits main-ATJYEVFT.js, which the postbuild.js regex misses, so version.json gets "hash": "". The placeholder is also in a lazy chunk rather than the main bundle. Recorded in environment.md and modules/app-shell.md.

Checks

  • npx nx build 36-blocks --configuration=production succeeded, followed by node tools/postbuild.
  • npx nx build 36-blocks-widget succeeded.
  • A link and anchor check over AGENTS.md and docs/** found no broken links.
Open in Web Open in Cursor 

@harshhsahu

Copy link
Copy Markdown
Collaborator Author

Requested via the dashboard · req_f88fa9b8
Add the agent guide and docs to this repository, written…

Add the agent guide and docs to this repository, written from the code as it is. At the root, an AGENTS.md: what the repository does in one paragraph, how to install, run and test it, the rules an agent must follow here, and what to read next. Under docs/: ARCHITECTURE.md (modules, data, who calls whom), FLOWS.md (the main flows, step by step), CONFIGURATION.md (every setting and environment variable, without values), DECISIONS.md (why it is shaped like this, as far as the code and history show…

Added automatically by the AI middleware.

@dvCodeWorld
dvCodeWorld merged commit c9a7aa0 into stage Nov 3, 2026
1 check passed
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