Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0001-docs FR-002
The guides lens (commons 0011-documentation FR-032): pages that people write in Markdown for the reader who is new to a repository (a path for each kind of reader, the ideas the repository is built on, and how to do the common things), kept in the repository beside the code and checked like every page: its citations of a specification and its links to a file or a folder become links, an unknown requirement is a finding, and a page names the section and group it is in. The lens knows nothing of what the guides say.
Source: commons/docs/src/lens/guides.ts
1 of 3 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.
GuideSpecinterfaceno test imports itinterface GuideSpec
One guide: its Markdown file and where it is in the site.
| Member | Type | What it is |
|---|
file | string | The Markdown file, from the repository's root. Its first heading is the page's title. |
path | string | The page's address on the site, as start/new-developer.html. |
section | "concepts" | "howto" | "start" | The section it is in. |
group | string | The group of the navigation it is in. |
order | number | Its place in its group, lowest first. |
GuidesOptionsinterfaceno test imports itinterface GuidesOptions
What the guides lens is given.
| Member | Type | What it is |
|---|
name | string | Its name, which the build reports it by. |
guides | readonly GuideSpec[] | The guides, which include the index page of each section it uses. |
function guidesLens(options: GuidesOptions): Lens
The guides lens.
Imported by 3 tests of the run (3 passed, 0 failed): the library's results