- Python 39.7%
- SCSS 30%
- HTML 15%
- JavaScript 6.3%
- Liquid 4.6%
- Other 4.4%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .forgejo/workflows | ||
| _includes | ||
| _layouts | ||
| _plugins | ||
| _sass | ||
| assets | ||
| bin | ||
| claude-code | ||
| contributing | ||
| e2e | ||
| fixtures | ||
| foundations | ||
| lib/tasks | ||
| marketplace | ||
| overview | ||
| roadmap | ||
| splent_cache | ||
| splent_cli | ||
| splent_framework | ||
| tests | ||
| tutorials | ||
| .coverage | ||
| .DS_Store | ||
| .env | ||
| .gitattributes | ||
| .gitignore | ||
| 404.html | ||
| _config.yml | ||
| CNAME | ||
| CODE_OF_CONDUCT.md | ||
| docker-compose.yml | ||
| Dockerfile | ||
| favicon.ico | ||
| Gemfile | ||
| Gemfile.lock | ||
| getting-started.md | ||
| index.md | ||
| just-the-docs.gemspec | ||
| LICENSE.txt | ||
| linux-environment.md | ||
| package-lock.json | ||
| package.json | ||
| Rakefile | ||
| README.md | ||
| robots.txt | ||
| whats-new.md | ||
| windows-environment.md | ||
SPLENT Docs
Official documentation for the SPLENT ecosystem (framework, CLI, and feature system).
Published at docs.splent.io
Local development
This site lives in the same workspace as splent_cli and splent_framework.
splent_workspace/
├── splent_framework/ # Core library
├── splent_cli/ # CLI tool
└── splent_docs/ # This site (Jekyll + Just the Docs)
All three repositories live under the splent-io organisation on
git.splent.io.
Run locally with Docker
cd splent_docs
docker compose up -d --build
Open localhost:4001
Run locally with Jekyll
cd splent_docs
bundle install
bundle exec jekyll serve --port 4001
Structure
splent_docs/
├── index.md # Landing page
├── getting-started.md # Quick start guide
├── linux-environment.md # Setting up Linux for the workspace
├── windows-environment.md # Setting up Windows (WSL) for the workspace
├── tutorials/ # Step-by-step tutorials
├── foundations/ # Core concepts (lifecycle, sources of truth)
├── splent_framework/ # Framework documentation
├── splent_cache/ # The .splent_cache directory
├── marketplace/ # The SPLENT marketplace
├── claude-code/ # The Claude Code plugin
├── contributing/ # Testing the CLI and the framework
├── roadmap/ # What comes next
├── e2e/ # Runner that walks Getting Started and the tutorials
├── tests/ # pytest checks of links, navigation and the command index
└── splent_cli/ # CLI reference, one page per command
├── feature/ # feature:* commands
├── product/ # product:* commands
├── spl/ # spl:* commands
├── database/ # db:* commands
├── cache/ # cache:* commands
├── check/ # check:* commands
├── release/ # release:* commands
├── marketplace/ # login, logout, whoami, marketplace:index, marketplace:search
├── export/ # export:* commands
├── env/ # env:* commands
├── clear/ # clear:* commands
├── manage/ # make targets of the workspace
├── misc/ # command:create
└── testing/ # lint, coverage, locust, selenium
Testing
Two kinds of checks keep the pages honest.
The docs tests are fast and need no Docker. They check that internal links and anchors resolve, that the navigation tree is consistent and that the command index matches the CLI next to the docs. Run them after any edit.
cd splent_docs
python3 -m pytest tests -q
Inside a SPLENT workspace, ../.release_venv/bin/python -m pytest tests -q
uses the workspace's own environment.
The checks of what the pages say about the CLI, the framework and the
features read their sources. They are looked for in the nearest folder above
the docs that holds splent_cli, so the docs may sit next to the CLI or one
level further in (splent_workspace/_reference/splent_docs), or in the
folder SPLENT_DOCS_WORKSPACE names. Without one those checks are skipped.
The deploy workflow runs the same tests before it publishes: it checks out
splent_cli and splent_framework next to the docs, installs them, runs
the link, anchor and navigation checks, then every other test, and builds
and publishes the site only when they pass. The features are not checked
out there, so the checks of the catalog pages run in a workspace only.
The end-to-end runner walks Getting Started and Tutorials 1 to 7 in a brand-new
workspace, runs the commands the pages mark and compares what they print with
the output the pages show. --with-claude adds Tutorial 8, which calls Claude
and costs tokens. It needs Docker and takes about 12 minutes with a warm cache. Run it before every release of splent_cli or splent_framework,
and after changing a command or its output on a tutorial page.
cd splent_docs
python3 e2e/run.py
e2e/README.md explains how pages are marked, how output is compared and every option of the runner.
License
Creative Commons CC BY 4.0 - SPLENT - Diverso Lab