IF Commons GitHub

links

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0001-docs FR-001

Where the words of documentation link to (commons 0011-documentation FR-011, FR-012, FR-025): a citation of a specification of the repository (its prefix and an id, as commons 0009-example; a bare id of its own form, as 0009-example in commons or 096-bun-runtime in Stolos; a number of its digits after spec or before a requirement, as spec 004 or 038 FR-014, where a specification has that number; FR-026 after any of these; or a bare FR-045 in an area, which names a requirement of the area's specification) becomes a link to the specification's page and the requirement's anchor; a citation of a repository the configuration lists as linked goes to that repository's site; one of any other repository (erga 009-machine-bootstrap) stays text; a Markdown link to a file of the repository goes to the page that shows the file, or to the file on GitHub; and {@link name} goes to the export it names. What does not resolve is a finding.

Source: commons/docs/src/links.ts

0 of 1 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

LinkScopeinterfaceno test imports it
interface LinkScope

Where a page's words are: the page, the file they come from, the area and the specification a bare requirement names.

MemberTypeWhat it is
pagestringThe page the links are on.
filestringThe file of the repository the words are in, from the root, for relative links and for findings.
area?stringThe area whose exports {@link name} names first.
spec?stringThe specification a bare FR-nnn is a requirement of.

Titles, headings, exports, tables, columns and requirements. Esc closes.