Skip to content

Commit 8bef0e6

Browse files
authored
Docs consolidation (#267)
* Docs: move bech32, update links & navigation Reorganize documentation structure and references: rename/move bech32 from build/spec to sdk/next/advanced and add a Supported Key Schemes section; update docs.json navigation to include the advanced bech32 page and adjust page groups. Bulk-update internal links to point to the new learn/concepts/* and learn/intro/* locations (replacing many learn/advanced and learn/beginner references). Remove the large learn/advanced/baseapp file and update pages that referenced it. Add a Work Log note to CLAUDE.md and add work-log/consolidation-final.md. These changes keep cross-references consistent with the new docs layout. * Remove app_di/runtime docs and update nav Delete legacy app wiring and runtime-related docs and clean up navigation. Removed multiple MDX files (e.g. sdk/next/build/building-apps/app-go-di.mdx, sdk/next/build/building-apps/runtime.mdx, sdk/next/build/building-modules/depinject.mdx, sdk/next/build/building-modules/invariants.mdx, sdk/next/build/building-modules/module-interfaces.mdx, sdk/next/learn/advanced/cli.mdx, sdk/next/build/packages/depinject.mdx) and updated docs.json to remove their sidebar entries. Also updated references in ABCI docs to point to app.go (prepare/propose handlers) instead of app_di.go. Miscellaneous content and package docs touched to reflect these removals. * Doc: update encoding/autocli and protobuf annotations Remove the old advanced/encoding page and update docs to use the new concepts/encoding and protobuf-annotations content. Added a dedicated protobuf-annotations section (Gogoproto guidance, interface annotations, scalar examples, method/field/message versioning, and updated amino examples) and updated internal cross-links (genesis, keeper, messages-and-queries, module-manager, auth tx). Heavily revised the AutoCLI doc (renamed to "Writing CLI Commands"): clarified usage, keyring behavior, root command setup, positional args, EnhanceCustomCommand semantics, examples pointing to release/v0.53.x SDK sources, and simplified many examples. Updated docs.json to remove the old encoding sidebar entry and reflect these changes. * Reorganize advanced docs and add simulator content Move and consolidate simulation and node-related docs into the new build/module simulator pages, remove outdated advanced pages, and update navigation and cross-links. Added a Bech32 configuration section (bech32.mdx), expanded simulator guidance (simulator.mdx) with test types, modes, running via go test and debugging tips, and updated references in build.mdx, intro.mdx, and tooling.mdx. Removed legacy pages (learn/advanced/grpc_rest.mdx, learn/advanced/node.mdx, and others) and updated docs.json to reflect the new structure; minor updates to run-node docs and work-log consolidated final. * consolidate * Update protobuf-annotations.mdx * consolidate * consolidation * add links * update structure * migrate * migrate * migrate * migrate * updating * consolidate * Move build docs to guides and update links Reorganize documentation by renaming/moving pages from sdk/next/build/* to sdk/next/guides/*, update docs.json navigation entries, and fix internal cross-links. Adds a new guides overview (sdk/next/guides/guides.mdx), deletes the old build/guides.mdx, and adjusts a protobuf docs title and related references to keep routing consistent. * Docs: restructure nav, anchors, and styling Restructure docs navigation and improve docs/content/UX: update docs.json to reorder Overview (fold home + start-here), add Lucide icons to nav groups, and move/organize pages across Overview/Intro/Concepts sections. Add anchor-link rules to CLAUDE.md to document Mintlify anchor behavior. Rename and retitle pages (home → "Cosmos SDK Docs", "Introduction to Blockchains" → "Blockchain Basics", "Start Here"), update cross-links and TOC anchors (preserve & in headings), and tweak learn.mdx and SDK intro/architecture references. Add contextual Note to autocli guide and a simsx/simulator reference link in testing docs. Improve code font by importing Fira Code in style.css and forcing mono font for code blocks. Update work-log with consolidation notes about nav changes, snippets, and a removed React import warning. * Update start-here.mdx * Update start-here.mdx * Update run-production.mdx * Update docs: remove build page and fix links Remove the SDK 'build' overview page (sdk/next/build.mdx) and update docs references: docs.json now points RFC and Specification groups to their README files. Also fix an internal anchor in sdk/next/learn/intro/cosmos-stack.mdx (BeginBlocker/EndBlocker link updated to block-lifecycle-hooks). These changes reflect doc restructuring and link corrections.
1 parent a2dd42e commit 8bef0e6

233 files changed

Lines changed: 2590 additions & 99036 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CLAUDE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,20 @@ Always use absolute Mintlify paths for internal links — never relative file pa
130130

131131
The path is the file's location relative to the `docs/` root, without the `.mdx` extension.
132132

133+
### Anchor Links
134+
135+
Mintlify preserves special characters in anchor IDs — do not drop them. Rules:
136+
137+
- Spaces → `-`
138+
- `&`, `+`, `/`, `=`, `@`, `#`, `$`, `%` → kept with surrounding hyphens (e.g. `Gas & Fees``#gas-&-fees`)
139+
- `?`, `!`, `(`, `)`, `:`, `` ` ``, ``, `*`, `.` → dropped (surrounding spaces still become `-`)
140+
- `-` in heading → stays as `-`, spaces around it collapse (e.g. `A - B``#a-b`)
141+
- All characters lowercased
142+
143+
## Work Log
144+
145+
Agents should log meaningful changes as they complete them — not at the end of the session. Each branch gets its own file in `work-log/`. Read [`work-log/CLAUDE.md`](work-log/CLAUDE.md) for format and instructions.
146+
133147
## Important Notes
134148

135149
- All documentation files use MDX format with Mintlify-specific components

docs.json

Lines changed: 178 additions & 294 deletions
Large diffs are not rendered by default.

sdk/next/build.mdx

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)