No description
  • Python 39.7%
  • SCSS 30%
  • HTML 15%
  • JavaScript 6.3%
  • Liquid 4.6%
  • Other 4.4%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
drorganvidez 4c1eeae296
Some checks failed
Deploy docs.splent.io / test (push) Failing after 1m40s
Deploy docs.splent.io / deploy (push) Has been skipped
Deploy docs.splent.io / alert (push) Successful in 4s
docs(getting-started): CLI 1.68.0
2026-11-19 14:05:54 +01:00
.forgejo/workflows Docs e2e can run on the forge, on a host runner labelled e2e 2026-11-18 23:03:06 +01:00
_includes product:build, product:deploy and the build, deploy and release page, to the point 2026-10-11 13:54:13 +02:00
_layouts fix: Fixes minor visual bugs 2026-04-19 01:05:40 +02:00
_plugins docs: the command index takes a page's lead past its table of contents 2026-10-31 17:10:59 +01:00
_sass Tables lose the square outline around their rounded corners 2026-11-02 18:22:42 +01:00
assets feat: Improves UI 2026-04-16 12:46:36 +02:00
bin docs: the docs say how SPLENT works, not which features exist 2026-10-25 14:52:36 +01:00
claude-code docs: the Claude Code pages, tightened 2026-10-31 18:08:51 +01:00
contributing Who owns what create writes, and the CI's time limits 2026-11-19 07:37:38 +01:00
e2e Docs e2e can run on the forge, on a host runner labelled e2e 2026-11-18 23:03:06 +01:00
fixtures first commit 2025-11-03 21:07:51 +01:00
foundations docs(ci): the product's CI says which images float 2026-11-19 13:55:28 +01:00
lib/tasks first commit 2025-11-03 21:07:51 +01:00
marketplace Use invented features in the pages outside the tutorials 2026-11-19 07:48:30 +01:00
overview docs: the SPLENT overview pages, tightened 2026-10-31 17:57:45 +01:00
roadmap docs: roadmap, rewritten to be read in minutes 2026-10-31 18:11:55 +01:00
splent_cache docs: SPLENT Cache, rewritten to be read in minutes 2026-10-31 18:08:49 +01:00
splent_cli docs(ci): the product's CI says which images float 2026-11-19 13:55:28 +01:00
splent_framework docs: what an earlier feature's init_feature set counts in the parameters' order 2026-11-19 12:22:37 +01:00
tests Use invented features in the pages outside the tutorials 2026-11-19 07:48:30 +01:00
tutorials Tutorial 2: check:infra counts the product's test database server 2026-11-19 08:53:19 +01:00
.coverage docs: marketplace section, contract fields, feature:info/search, check:contracts 2026-07-26 15:59:37 +02:00
.DS_Store first commit 2025-11-03 21:07:51 +01:00
.env feat: Upgrades tutorials 2026-04-01 17:03:24 +00:00
.gitattributes first commit 2025-11-03 21:07:51 +01:00
.gitignore e2e: walk the docs as a reader, starting with Getting Started 2026-10-02 11:24:26 +03:00
404.html first commit 2025-11-03 21:07:51 +01:00
_config.yml e2e: walk the docs as a reader, starting with Getting Started 2026-10-02 11:24:26 +03:00
CNAME Create CNAME 2025-11-16 14:08:23 +01:00
CODE_OF_CONDUCT.md Docs audit: make every page agree with CLI 1.26 and framework 1.15 2026-10-08 22:05:08 +02:00
docker-compose.yml feat: Improves UI 2026-04-16 12:46:36 +02:00
Dockerfile docker: ruby pinned by version and digest 2026-11-08 12:15:39 +01:00
favicon.ico feat: Add favicon 2025-11-16 13:53:53 +01:00
Gemfile Point the theme config, nav and topbar at the forge, and drop jekyll-github-metadata 2026-09-20 21:34:10 +02:00
Gemfile.lock Sync Gemfile.lock after dropping jekyll-github-metadata 2026-09-20 21:35:36 +02:00
getting-started.md docs(getting-started): CLI 1.68.0 2026-11-19 14:05:54 +01:00
index.md docs: home, getting started and the setup guides, tightened 2026-10-31 18:02:28 +01:00
just-the-docs.gemspec first commit 2025-11-03 21:07:51 +01:00
LICENSE.txt first commit 2025-11-03 21:07:51 +01:00
linux-environment.md docs: home, getting started and the setup guides, tightened 2026-10-31 18:02:28 +01:00
package-lock.json first commit 2025-11-03 21:07:51 +01:00
package.json first commit 2025-11-03 21:07:51 +01:00
Rakefile first commit 2025-11-03 21:07:51 +01:00
README.md ci: the docs are published only once their tests pass 2026-10-25 14:04:34 +01:00
robots.txt feat: Improves UI 2026-04-16 12:46:36 +02:00
whats-new.md docs(whats-new): 1.68, images pinned by digest 2026-11-19 13:55:28 +01:00
windows-environment.md docs: home, getting started and the setup guides, tightened 2026-10-31 18:02:28 +01:00

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