Repository navigation
Conversation
Add a Zensical documentation site in docs-site/, styled like the Containerlab Apps docs, with the containerlab wordmark and live topology diagrams from @containerlab/clab-viewer. - Get started, install, guides, and reference pages built from the former README, plus a full configuration reference - Split the Kubernetes doc into a setup guide and an internals reference - ReDoc API reference at /api/, keeping /swagger.json and /swagger.yaml at the site root - task docs / task docs:build via scripts/docs.sh - Pages workflow publishes the full site to gh-pages; a new docs workflow builds it on pull requests - README reduced to install, first call, and links to the site
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
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
Replaces the ~500-line README with a short one and moves the documentation to a GitHub Pages site, styled like the Containerlab Apps docs.
Site (
docs-site/, built with Zensical):curl) and how it worksTRUSTED_PROXIES), security model, Kubernetes internals, REST API/api/;/swagger.jsonand/swagger.yamlstay at the site root for existing links@containerlab/clab-viewerfromdocs-site/diagrams/*.clab.yml(theclabfence extension is shared with containerlab-app intools/clab_docs/)docs/kubernetes.mdis split into a setup guide and an internals reference. The RBAC manifests stay indocs/kubernetes/and are applied by URL.Build and publish:
task docspreviews the site,task docs:buildbuilds it (needsuv).scripts/docs.shcopies the OpenAPI spec and fetches the viewer bundlepages.ymlkeeps publishing to thegh-pagesbranch, so Pages settings are unchanged. It now replaces the branch contents on each publishdocs.ymlbuilds the site with--stricton pull requests that touch the docsNotes
/api/.Test plan
scripts/docs.sh buildpasses in strict mode