Skip to content

Commit 5846e36

Browse files
committed
docs: update documentation
1 parent 6bdb0a7 commit 5846e36

7 files changed

Lines changed: 20 additions & 7 deletions

File tree

mkdocs/docs/checks/names.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
This validation check looks for author names that could be mispelled or not using an author's preferred name.
66

77
!!! note
8+
This check requires internet access to fetch the latest list. It is cached on subsequent runs.
9+
810
A match doesn't automatically signify an error, but is simply to warn the user to verify whether the name is used properly.
911

1012
[View current list](hhttps://github.com/rfc-editor-drafts/common/blob/main/names.json)

mkdocs/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ hide:
1414

1515
*DraftForge is under active development. A beta release will be available in the coming months.*
1616

17-
[Getting Started](/install)
17+
[Getting Started](install.md)
1818
{ .md-button }

mkdocs/docs/tools/abbreviations.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1-
# List Inconsistent Formatting
1+
# List Abbreviations
22

33
## Description
44

5-
This tool performs...
5+
This tool lists all abbreviations and their expansion in the document.
6+
7+
*TODO*
8+
9+
!!! note
10+
This tool requires internet access to fetch the latest list. It is cached on subsequent runs.
11+
12+
[View current list](hhttps://github.com/rfc-editor-drafts/common/blob/main/abbreviations.json)
13+
{ .md-button }
614

715
## Supported Document Types
816

mkdocs/docs/tools/lookup-selection-across-docs.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
## Description
44

5-
This tool performs...
5+
This tool lists all instances of the selected text across all opened documents.
6+
7+
!!! tip
8+
This tool can be triggered from the right-click menu.
69

710
## Supported Document Types
811

mkdocs/docs/tools/strip-mline-endings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Description
44

5-
This tool performs...
5+
This tool removes all instances of `^4` in the document.
66

77
## Supported Document Types
88

mkdocs/docs/tools/surround-bcp14-keywords.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Description
44

5-
This tool performs...
5+
This tool ensures all BCP 14 keywords (e.g. `SHOULD`, `MUST NOT`, etc.) are enclosed in `<bcp14></bcp14>` tags.
66

77
## Supported Document Types
88

src/views/reference.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class ReferenceProvider {
1111
label: 'User Guide',
1212
description: 'How to use DraftForge',
1313
kind: 'link',
14-
href: 'https://github.com/ietf-tools/draftforge/blob/main/docs/README.md#usage'
14+
href: 'https://draftforge.ietf.org/usage/'
1515
},
1616
{
1717
id: 'general',

0 commit comments

Comments
 (0)