Pages
17 pages filed under Screens › Pages. A screen is a page of the application, with what it shows and what it allows.
| Screen | Roles | First line | Links |
|---|---|---|---|
| About this wiki | Reader | The page of trust: everything that lets a reader judge whether the site read is current. When it was built, from which repositories, at which version each was read, what the site leaves out and how a page is corrected. The footer of every page links to it, "See the sources and their versions". | 33 |
| Alphabetical index | Glossary owner, Reader | Every word the documentation uses, with or without a definition, by initial letter. Letters without an entry stay in view, struck through and inert. Each word is listed with its type, the first line of its page and the number of pages citing it; a word without a definition is dotted and described by the passage that uses it most. Sorting follows the collation rules of the project locale, accents included, and the words without a definition are never set apart: they are the working list of a glossary owner. | 85 |
| API page | Integrator, Reader | The page of an interface whose contract the build imported. Same shell as the entity page, laid out at the grain an interface is worked at: its operations. The tree lists them under the interface, a table matches them to the contract and states the gaps between the contract and the notes, the contract stands in a block of its own, shown and never copied into the text, and the panel keeps five keys and lifts the operations to the top of the related pages. An API without an imported contract keeps the generic entity page. | 73 |
| Category | Reader | The list of one category of a space: a folder of the repository at any depth, or a year or a month of a space whose every note is dated, where a card of the space page, a folder of the tree or a step of the breadcrumb leads. A category does not unfold in the tree, it opens as a page, the missing link between the space and the note. | 66 |
| Decision page | Reader | The page of an architecture decision: short, dated, with its consequences. Same shell as the entity page: the tree of the space on the left, the title and the panel where a reader expects them. A reader comes to check two things, whether the decision holds and since when, and finds them at the head of the panel; the rest of the page says what the decision changed. | 48 |
| Document page | Reader | The page of an office document, a slide deck, a report, a spreadsheet or a PDF, alone or merged with its note. Same shell as the entity page: the tree of the space on the left, the title and the panel where a reader expects them. Where the entity page puts the note, the document itself stands, its text and its notes one tab away, the original one click away. | 74 |
| Edge cases | Reader | What shows when something is missing. A static site has no support desk: the page is the only recourse. It names the cause in plain words, says what stays reachable despite the lack, and offers at least two ways out; no partial lack hides the rest of the page, and the navigation is always kept. A notice is allowed on these states alone, nowhere else in the site. | 81 |
| Entity page | Reader | The page of a note, laid out as a wiki a corporate reader already knows: the text in the centre, what the tool computed in the right panel. One template serves every type; only the labels of the attributes and the order of neighbours change, and both come from the profile. A type may have a page of its own: a component a theme or the type's module provides for it is rendered instead of the generic template, which stays the fallback of every type. | 123 |
| Exploring the site | The path a reader follows through the generated site, from a word to the notes that use it and back, without a server and without leaving the browser. Every step is a page of the site, so the process is filed among the screens it walks through. | 41 | |
| Gallery index | Theme author | The page set concordance gallery writes so that a theme is styled and checked without building a corpus: every slot of the site rendered with fixture view models, one page per slot and state, under an index that says who renders each slot. | 70 |
| Home | Reader | Two ways into a corpus: a word, or a space. The page opens on a question, "What are you looking for?", and a search field that answers it as the reader types, because every word used anywhere in the documentation has a page, defined or not. The most cited pages stand next to it as shortcuts. Then the spaces, the sources the site is fed by, each with its freshness from the git history, and the pages changed last. A space that has not moved past the staleness threshold is named in an alert. | 77 |
| Keyword page | Glossary owner, Reader | The page of a word nobody defined. Same template as the entity page, without the markdown and the declared properties. A banner says that no note exists and how many passages were recorded. Three numbers only: occurrences, files, sources. The passages follow, grouped by page in corpus order, two in view per page, with their context. The words that accompany the expression are its neighbourhood map, drawn from its co-occurrences, and expressions with a similar form are offered as a lead, worded to assert nothing. | 115 |
| Meeting page | Reader | The page of a working session that exists as a note, a transcript and a deck, read as one page. Same shell as the entity page: the tree of the space on the left, the title and the panel where a reader expects them. Where the entity page puts the note, the three files stand as tabs; what the meeting produced, a decision written elsewhere, is named in a callout rather than mixed into the text. | 75 |
| Search | Reader | Full-text search over the whole corpus, without a server. The index is generated at build and loaded in fragments as the user types. Facets on type, source, domain and application carry counts frozen at build; they combine, and a facet with no result is disabled rather than hidden. The query and the active filters live in the URL, so a search can be sent to a colleague and replays exactly. | 90 |
| Space | Reader | The page of one source, where a row of the home or of the spaces page leads: one changes page, nothing unfolds. A space reads like a small wiki within the wiki: its own search, its own vocabulary, its own news. | 81 |
| Spaces | Reader | The second way into a corpus, after a word: a space, one per source the site is fed by. The page lists every space, none folded, and completes the first five of the home. A row leads to the page of the space, never unfolds a tree. | 80 |
| To-do page | Author, Quality owner | Three lists, nothing else: documents without a markdown representation, words above the threshold without a note, and, folded, the suspected noise the confidence set aside. Each entry of the first two leads to the page concerned and states its occurrence or file count; the lists are sorted by decreasing count, then by identifier. This is not a health report; the linter in continuous integration plays that role. | 78 |
17 pages of 17 — pagination by twenty. The Links column counts the related pages, which brings the most central pages of the journey to the top.