Skip to content

README.md

Latest commit

 

History

History
75 lines (51 loc) · 3.69 KB

README.md

File metadata and controls

75 lines (51 loc) · 3.69 KB
Raw

Innovative License Management Solution

Labs64 NetLicensing Wiki - Innovative License Management Solution

Lint NetLicensing Wiki

Visit Labs64 NetLicensing at https://netlicensing.io

Run

System Requirements

To be able to run the wiki locally you need Docker with Compose.

Docker

  1. Clone repository
git clone https://github.com/Labs64/wiki.git
  1. Start environment
docker compose up -d

Now you can browse the site at http://localhost:4000/wiki/. The first start takes a minute (it downloads the theme and installs gems); pages rebuild when you save a file.

  1. Stop environment
docker compose down

Repository layout

Path What it is
docs/ The published site (Jekyll source). Pages are Markdown with front matter; the theme comes from Labs64/NetLicensing-Wiki-template via remote_theme.
docs/_data/changelog.yml Source of the changelog, the home page "What's new" block and the RSS feed. See the comment at the top of the file for the entry format.
docs/guides/ Task and concept guides (licensing API, offline validation, model comparisons, build vs buy, language quick starts).
docs/netlicensing-mcp/ MCP server pillar page plus client setup, workflows and security pages.
docs/llms.txt Machine-readable site index for AI assistants, generated from page front matter.
scripts/ CI helpers.

Checks

Every push and pull request runs netlicensing-wiki-lint.yml: it builds docs/ the same way GitHub Pages does, verifies that the guided-tour anchors still exist, and runs HTMLProofer on internal links, images and scripts. To reproduce locally:

mkdir -p /tmp/wiki-site && docker run --rm -v "$PWD/docs:/srv/jekyll" -v /tmp/wiki-site:/out -w /srv/jekyll \
  jekyll/jekyll:pages jekyll build --future --strict_front_matter --baseurl "" -d /out
python3 scripts/check-tour-anchors.py /tmp/wiki-site docs/assets/js/guidechimp-tours.js

Credits

  • Just the Docs - A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.

License and Copyright

Following files, directories and their contents are copyright Labs64. You may not reuse anything therein without permission:

  • docs/ including all subdirectories

All other files and directories are licensed under the MIT License unless explicitly stated.

Page front matter conventions

Key Purpose
title Descriptive page title used for <title>, the H1, breadcrumbs and llms.txt. Child pages reference their parent by this exact value in parent: / grand_parent:.
nav_title Optional short label for the sidebar when title is long.
description One or two factual sentences; shown in search results, social previews and llms.txt. Do not repeat the title.
last_modified_at Date of the last substantive change (YYYY-MM-DD); feeds the sitemap lastmod and JSON-LD dateModified.
faq_category FAQ pages only: the group on the FAQ index. FAQ pages also get FAQPage structured data from the theme.