juddisjudd/svocs

SVOCS presents a strong and welcoming approach to documentation sites. It combines Markdown, Svelte components, static output, multiple search choices, generated social cards, math, diagrams, theming, migration tools, and AI-friendly text endpoints. The project’s own site being built with SVOCS is useful proof that the system can support real documentation. The quick-start commands cover Bun, pnpm, npm, and Deno, and the README is honest about the current mdsvex warning. It also gives respectful credit to the open-source tools it builds on, which is a good community signal.

The project covers a wide surface for a young codebase. Five search backends, several migration sources, multiple package managers, multiple deployment targets, base paths, social image generation, and Svelte components create many possible combinations. The README lists a unit-test command, but no test files or recent GitHub Actions runs were visible during review. A public compatibility matrix and automated workflow would give users more confidence. The highest-value tests would scaffold a fresh site, build it, verify links and generated routes, test a base-path deployment, and run each migration against a small fixture. Accessibility checks should cover the search dialog, tabs, collapsible sections, theme switch, sidebar, and keyboard focus.

The scaffolder can analyze an existing GitHub repository and optionally use an LLM. Its documentation should state which files are read, what is sent to the model, how secrets are excluded, and whether content is stored by a provider. Migration tools should always preserve the source project and produce a clear report of files that need human review.

The README is already clear, but the project would benefit from a support policy for SvelteKit, Svelte, Node, Bun, pnpm, and Deno versions. Overall, SVOCS is creative, attractive, and developer-friendly. A visible test suite, compatibility promises, and privacy details for repository analysis would help it grow from a strong new tool into a dependable documentation platform.

SVOCS is a Markdown-first documentation generator built on SvelteKit and Svelte 5, with static output and optional Svelte components for richer pages. Its default feature set is strong: reusable documentation components, several search backends, build-time social cards, math, Mermaid, theming, llms.txt, sitemap generation, and base-path deployment. The doctor, update, and migration commands are especially useful because they address maintenance rather than only initial scaffolding.

The biggest adoption question is long-term upgrade stability. Template-based projects can drift, so conflict handling, compatibility promises, and escape hatches should be documented and tested. Migration quality would be easier to trust with fixtures covering complex components, links, redirects, localization, and search indexes. Accessibility audits, large-site build benchmarks, and a stable extension contract would further strengthen the project. SVOCS is best for Svelte teams that want a polished static docs experience while retaining plain Markdown; teams with heavily customized existing sites should trial migration on representative content first.