Skip to content

docs: truth-pass — real README, terminology wiring, setup-guide nav, prune dead files - #71

Merged
saqlainsyed007 merged 1 commit into
developfrom
docs/truth-pass-962
Jul 28, 2026
Merged

docs: truth-pass — real README, terminology wiring, setup-guide nav, prune dead files#71
saqlainsyed007 merged 1 commit into
developfrom
docs/truth-pass-962

Conversation

@saqlainsyed007

@saqlainsyed007 saqlainsyed007 commented Jul 28, 2026

Copy link
Copy Markdown

Part of the cross-repo CLAUDE.md/docs truth pass — tracebloc/backend#962. Every claim re-verified against the current main tree.

Fixes

Stock Mintlify boilerplate → real README

  • README.md was the verbatim "Mintlify Starter Kit" template ("Click the green Use this template button…"). Replaced with an actual tracebloc-docs README: what the repo is, local preview commands, section map, a note on synced pages, contributing, and the deploy-on-push-to-main flow.

Terminology wiring (the important one)

  • AGENTS.md still had the stock "First-time setup: Customize this file…" placeholder banner and an empty ## Terminology section ({/* Add product-specific terms */}), even though a 17KB authoritative TERMINOLOGY.md exists. The docs-sync automation is instructed to follow AGENTS.md and so never saw the terminology rules. Removed the banner and pointed the Terminology section at TERMINOLOGY.md.
  • CLAUDE.md: added TERMINOLOGY.md to Key files and marked it authoritative.

environment-setup/setup-guide.mdx missing from nav

  • The page exists, is synced from tracebloc/client's README (.github/sync-sources.ymldest: environment-setup/setup-guide.mdx), and has 7 inbound links (from overview/tracebloc, create-use-case/prerequisites, create-use-case/define, tools-help/faqs, environment-setup/eks-client-deployment-guide) — but it was absent from docs.json navigation, so unreachable by browsing. Re-added it to the Environment Setup group (after quickstart). Chosen over retargeting the 7 links + sync mapping as the far less disruptive option.

Pruned dead files

  • Deleted evals.json — a ~154KB metrics-formula dump referenced nowhere in the repo.
  • Deleted 4 unused images: tabular_classification_example.png, tabular_example.png, tabular_timeseries_example.png, timeseries_example.png. (The audit said "6 unused images" — as of today only these 4 are actually unreferenced; the other two flagged in July are now in use.)

Scope

Docs / config / asset cleanup. docs.json validated as JSON; no page content rewritten (setup-guide.mdx itself is unchanged — only re-listed in nav).


Note

Low Risk
Documentation, navigation, and asset cleanup only; no application code or security-sensitive behavior changes.

Overview
Docs truth pass for the Mintlify site: contributor-facing files and nav are aligned with how the repo actually works, without rewriting MDX page bodies.

README replaces the stock Mintlify starter template with tracebloc-specific content: what the site is, local mint commands, section map, synced pages via .github/sync-sources.yml, and deploy-on-push to main.

Terminology for AI/docs automation: AGENTS.md drops the placeholder banner and empty Terminology section; it now defers to TERMINOLOGY.md as the single vocabulary source. CLAUDE.md lists TERMINOLOGY.md as authoritative alongside AGENTS.md.

Navigation: environment-setup/setup-guide is added to docs.json (after quickstart) so the synced client setup page is reachable in the sidebar despite existing inbound links.

Cleanup: Deletes unreferenced evals.json (large metrics-formula dump) and unused tabular/timeseries example images from the diff scope.

Reviewed by Cursor Bugbot for commit 44657ad. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tracebloc 🟢 Ready View Preview Jul 28, 2026, 9:50 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@saqlainsyed007 saqlainsyed007 self-assigned this Jul 28, 2026
@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tracebloc 🟡 Building Jul 28, 2026, 9:50 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@saqlainsyed007
saqlainsyed007 changed the base branch from main to develop July 28, 2026 18:57
…prune dead files (tracebloc/backend#962)

- README.md: replaced the stock "Mintlify Starter Kit" boilerplate with a
  real tracebloc-docs README (what it is, local preview, structure, synced
  pages, contributing, deploy-on-push-to-main).
- AGENTS.md: removed the stock "First-time setup / customize this file"
  placeholder banner; filled the empty Terminology section to point at
  TERMINOLOGY.md (the sync automation follows AGENTS.md, so it now sees the
  terminology rules).
- CLAUDE.md: added TERMINOLOGY.md to Key files and marked it authoritative.
- docs.json: re-added environment-setup/setup-guide to the nav. The page
  exists, is synced from tracebloc/client (.github/sync-sources.yml) and has
  7 inbound links, but was unreachable from navigation. Re-adding to nav is
  far less disruptive than retargeting all the links.
- Deleted evals.json (~154KB unreferenced metrics dump) and 4 unused images
  (tabular_classification_example, tabular_example, tabular_timeseries_example,
  timeseries_example .png). (Audit said "6 unused images"; only these 4 are
  actually unreferenced now.)

Part of the cross-repo docs truth pass, tracebloc/backend#962.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@LukasWodka
LukasWodka force-pushed the docs/truth-pass-962 branch from 9c1d993 to 44657ad Compare July 28, 2026 19:10
@saqlainsyed007
saqlainsyed007 merged commit bcbdc7d into develop Jul 28, 2026
6 checks 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.

4 participants