1Purpose
This document is a translation in substance. The reference is the original document in French; extensions and changes are always made there.
The Kit is the common base of the sub-sites. This document describes how a sub-site presents itself to its readers, what it keeps outside that presentation, and on what condition this second part becomes public.
It holds for every project using the Kit. The mechanisms described belong to the Kit; their content belongs to the project.
2Two parts
Each sub-site covers one subject — a press review, an equipment inventory, a family record, the documentation of a tool. It has two parts, both present from the first session.
| Part | Contains | Reader |
|---|---|---|
| Shown | The subject itself, and a page explaining how to read the display | Whoever comes to read |
| Technical | Operating documentation, Prompt, own stylesheets and modules, generators, Registry | Whoever maintains the project |
3The decision to share
At some point the technical part of a sub-site may be packaged and made downloadable. That is a decision, taken or not; not taking it is a stable state, not unfinished work.
The criterion is not the maturity of the documentation but the value to a third party. A project can be carefully documented and have nothing to offer anyone — a family record, a personal inventory. The question is: would someone else get something out of it.
–What the decision produces. A downloadable file, named after the sub-site: Kit-News, Kit-Testament. In prose, the kit of the news sub-site. The file name carries its version — kit-news-1.4.zip — as the Kit carries its own.
–What it makes visible. The footer sentence and the download icon, which do not render without it. The page explaining the display exists independently.
4What a sub-site kit contains
It contains what is needed to reproduce the sub-site, not what describes it. A store of documents without a production chain does not meet the contract.
–Operating documentation. What the sub-site produces, where its data comes from, how a pass runs.
–Project Prompt. The permanent instructions: conventions, constraints, what is no longer decided.
–Own stylesheets and modules. What the project added to the Kit, and the tables it declares.
–Generators and Registry. The production chain, and what declares its active state.
5Two readers
The two parts serve two readers whose needs do not overlap.
| Reader | Wants | Receives |
|---|---|---|
| The reader | To understand what is in front of them | A short explanation of the display |
| The reuser | To reproduce what they see | The documentation and the sub-site kit |
6Three ways in
Each sits where its reader looks, and renders only if the project declares it.
| Way in | Location | Leads to |
|---|---|---|
| Information badge | Top of the page being read, scrolls with it | Explanation of the display |
| Footer sentence | End of the documentation index | Instructions for adapting |
| Download icon | Index bar | The sub-site kit |
7Split
The Kit provides the mechanism, the project provides what it carries.
| The Kit provides | The project provides |
|---|---|
| The bar, its slots, the two language selectors | Site name, published languages, icon target |
| The two shapes of reader-facing page | The words they carry |
| The download mechanism and its contract | The contents of its kit, if it publishes one |
| The palette and the means to replace it | Its colours, if it declares any |
| The rule: an undeclared element does not render | Its declarations, hence what renders |
| The rule: no link underlined, in any state | Nothing — the rule is not declared |
8Rules
–Inform on request. The three ways in answer whoever uses them and stay silent otherwise. Their rendering depends on a declaration by the project.
–One publication. A sub-site kit is served from the same pages as its subject. Nothing is duplicated, no section is reserved.
–Runnable kit. A published kit unpacks and produces the site. What does not run is not published.
–No commitment to support. A published kit must be complete and accurate. Its use by a third party remains their affair.