docs: truth-pass — real README, terminology wiring, setup-guide nav, prune dead files - #71
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
aptracebloc
approved these changes
Jul 28, 2026
saadqbal
approved these changes
Jul 28, 2026
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…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
force-pushed
the
docs/truth-pass-962
branch
from
July 28, 2026 19:10
9c1d993 to
44657ad
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of the cross-repo CLAUDE.md/docs truth pass — tracebloc/backend#962. Every claim re-verified against the current
maintree.Fixes
Stock Mintlify boilerplate → real README
README.mdwas 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-mainflow.Terminology wiring (the important one)
AGENTS.mdstill had the stock "First-time setup: Customize this file…" placeholder banner and an empty## Terminologysection ({/* Add product-specific terms */}), even though a 17KB authoritativeTERMINOLOGY.mdexists. The docs-sync automation is instructed to followAGENTS.mdand so never saw the terminology rules. Removed the banner and pointed the Terminology section atTERMINOLOGY.md.CLAUDE.md: addedTERMINOLOGY.mdto Key files and marked it authoritative.environment-setup/setup-guide.mdxmissing from navtracebloc/client's README (.github/sync-sources.yml→dest: environment-setup/setup-guide.mdx), and has 7 inbound links (fromoverview/tracebloc,create-use-case/prerequisites,create-use-case/define,tools-help/faqs,environment-setup/eks-client-deployment-guide) — but it was absent fromdocs.jsonnavigation, so unreachable by browsing. Re-added it to the Environment Setup group (afterquickstart). Chosen over retargeting the 7 links + sync mapping as the far less disruptive option.Pruned dead files
evals.json— a ~154KB metrics-formula dump referenced nowhere in the repo.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.jsonvalidated 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
mintcommands, section map, synced pages via.github/sync-sources.yml, and deploy-on-push tomain.Terminology for AI/docs automation:
AGENTS.mddrops the placeholder banner and empty Terminology section; it now defers toTERMINOLOGY.mdas the single vocabulary source.CLAUDE.mdlistsTERMINOLOGY.mdas authoritative alongsideAGENTS.md.Navigation:
environment-setup/setup-guideis added todocs.json(afterquickstart) 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.