docs: Diátaxis rewrite and TypeDoc API reference - #230
Merged
Merged
Conversation
|
View your CI Pipeline Execution ↗ for commit 586f116
💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗ ☁️ Nx Cloud last updated this comment at |
4 tasks
Restructure docs into Getting Started / Guides / Understanding / Reference following the writing-technical-docs skill. Wire starlight-typedoc for core, console-driver, and http-driver public APIs (same pattern as naxodev/oss). Preserve legacy redirects and update docs e2e. Signed-off-by: Nacho Vazquez <nacho@naxo.dev>
Unblocks CI format:check and lists bun alongside pnpm/npm/yarn. Signed-off-by: Nacho Vazquez <nacho@naxo.dev>
Replace the broken install table / inline alt commands with Starlight Tabs (pnpm, bun, npm, yarn), synced via syncKey across both pages. Signed-off-by: Nacho Vazquez <nacho@naxo.dev>
Keep Tabs outside Steps — Prettier 2.8 mangles nested MDX components. Signed-off-by: Nacho Vazquez <nacho@naxo.dev>
Fix withHttpConfig vs withHttpOptions levels claim, make factory snippet runnable, add dynamic-payload example, trim intro pipeline duplication, fix bare provideLumberjack/format pseudo-syntax, rewrite splash cards, and clean minor phrasing nits. Signed-off-by: Nacho Vazquez <nacho@naxo.dev>
NachoVazquez
force-pushed
the
docs/diataxis-rewrite-and-reference
branch
from
July 24, 2026 14:05
9ebe3bd to
586f116
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
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
Stacked on #229. Rewrites the docs site content to Diátaxis (skill: writing-technical-docs) and adds a Reference section generated with
starlight-typedoc, matching the naxodev/oss docs pattern.Structure
@ngworker/lumberjack,console-driver,http-driverNotes
/docs/*and first-migration/guides/usagepaths redirect to the new slugs.src/content/docs/reference/**is gitignored (built onastro build/ CI).Test plan
nx build docs-lumberjack-docs-appnx e2e docs-lumberjack-docs-app-e2e