docs: restructure documentation into logical sections#50
Merged
pratyush618 merged 1 commit intomasterfrom Apr 7, 2026
Merged
Conversation
Reorganize the flat guide/ directory (26 files) into six subdirectories matching the nav hierarchy: core/, reliability/, execution/, extensibility/, observability/, and operations/. Split the 820-line api/queue.md monolith into six focused sub-pages under api/queue/. Split dashboard.md (541 lines) into a tutorial page and a separate REST API reference. Eliminate the catch-all advanced.md by redistributing its content to proper locations (unique-tasks, batch-enqueue, job-management, integrations/fastapi). Add 10 section index pages with overview tables. Enable navigation.tabs, navigation.sections, navigation.indexes, navigation.path, and navigation.prune in zensical.toml. Fix escaped pipes in type annotations across 11 files. Fix all 33+ cross-references. Delete orphaned guide/otel.md (duplicate of integrations/otel.md).
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
1 participant
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.
Summary
guide/directory (26 files) into 6 logical subdirectories:core/,reliability/,execution/,extensibility/,observability/,operations/api/queue.mdmonolith into 6 focused sub-pages underapi/queue/dashboard.mdinto tutorial + REST API referenceadvanced.md— redistribute content to proper locations\|→|) in type annotations across 11 filesguide/otel.md(duplicate ofintegrations/otel.md)Before / After
Test plan
zensical buildpasses with zero warnings