Add Docify CLI and restructure /docs as platform documentation#35
Merged
Conversation
## Docify CLI (packages/cli/) New @devdocify/cli npm package — the DevDocify equivalent of the Mintlify CLI. All commands start with `docify`. Commands implemented: - docify dev start local dev server (package manager aware) - docify build production build - docify validate run lint-content script - docify broken-links build and report broken links - docify new <dir> scaffold a new DevDocify project - docify update upgrade CLI to latest - docify score <url> SEO signal check, score out of 6 - docify analytics Algolia analytics guidance - docify a11y axe-core accessibility guidance - docify config read/write ~/.docify/config.json ## Docs restructure /docs is now about the DevDocify platform, not the demo APIs: - New tutorials: quick start with the CLI - New how-to guides: add a docset, add a playground, configure search, deploy to Vercel - New reference: full CLI command reference Playground guides moved to their own docsets: - docs/devdocify/how-to/tfl-playground.md → docs/tfl/getting-started/playground.md - docs/devdocify/how-to/petstore-playground.md → docs/petstore/getting-started/playground.md playground-overview.md renamed and reframed: - docs/devdocify/how-to/add-playground.md Navigation updated across all three docsets.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Preview deployment
Updated on each push to this PR. |
…nsparent panel rendering
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
Docify CLI (
packages/cli/)New
@devdocify/clinpm package — the DevDocify equivalent of the Mintlify CLI. Install globally withnpm i -g @devdocify/cli.docify devdocify builddocify validatedocify broken-linksdocify new <dir>docify updatedocify score <url>docify analyticsdocify a11ydocify config~/.docify/config.jsonDocs restructure
/docsis now product documentation for the DevDocify platform itself (not the demo APIs):Playground guides moved to their own docsets:
docs/tfl/getting-started/playground.mddocs/petstore/getting-started/playground.mdNavigation updated across all three docsets.
Test plan
pnpm startbuilds without errors/docsshows platform documentation (not demo API content)/tfl/getting-started/playgroundand/petstore/getting-started/playgroundresolve correctly/docs/reference/cli/docs/tutorials/quick-start