Skip to content

chore(ospobook): add proper footnotes #154

chore(ospobook): add proper footnotes

chore(ospobook): add proper footnotes #154

Triggered via pull request April 17, 2025 09:06
Status Success
Total duration 20s
Artifacts

review-docs.yaml

on: pull_request
Review docs
7s
Review docs
Fit to window
Zoom out
Zoom in

Annotations

10 errors, 10 warnings, and 10 notices
"TODO.EmDash": ospo-book/content/en/00-chapter.md#L9
Don't put a space before or after a dash.
"TODO.Spacing": ospo-book/content/en/00-chapter.md#L9
's. B' should have one space.
"TODO.LyHyphens": ospo-book/content/en/toc.md#L9
'early-stage' doesn't need a hyphen.
"TODO.EmDash": ospo-book/content/en/05-chapter.md#L25
Don't put a space before or after a dash.
"TODO.EmDash": ospo-book/content/en/05-chapter.md#L27
Don't put a space before or after a dash.
"TODO.EmDash": ospo-book/content/en/05-chapter.md#L74
Don't put a space before or after a dash.
"TODO.EmDash": ospo-book/content/en/05-chapter.md#L85
Don't put a space before or after a dash.
"TODO.EmDash": ospo-book/content/en/references.md#L94
Don't put a space before or after a dash.
"TODO.Ordinal": ospo-book/content/en/references.md#L101
Spell out all ordinal numbers ('2nd') in text.
"TODO.LyHyphens": ospo-book/content/en/03-chapter.md#L146
'early-stage' doesn't need a hyphen.
"TODO.Will": ospo-book/content/en/07-chapter.md#L7
Avoid using 'will'.
"TODO.We": ospo-book/content/en/07-chapter.md#L42
Try to avoid using first-person plural like 'we'.
"TODO.Will": ospo-book/content/en/07-chapter.md#L44
Avoid using 'will'.
"TODO.Headings": ospo-book/content/en/00-chapter.md#L7
'What is This Book About?' should use sentence-style capitalization.
"TODO.Headings": ospo-book/content/en/00-chapter.md#L20
'What’s Not in This Book' should use sentence-style capitalization.
"TODO.Headings": ospo-book/content/en/00-chapter.md#L26
'Who Should Read This Book?' should use sentence-style capitalization.
"TODO.Will": ospo-book/content/en/00-chapter.md#L30
Avoid using 'will'.
"TODO.Headings": ospo-book/content/en/toc.md#L7
'Chapter 1: Introduction to Open Source Program Offices' should use sentence-style capitalization.
"TODO.WordList": ospo-book/content/en/toc.md#L9
Use 'documents', 'pages', or 'sections' instead of 'chapter'.
"TODO.Headings": ospo-book/content/en/toc.md#L11
'Chapter 2: The Value of Open Source Program Offices' should use sentence-style capitalization.
"TODO.Passive": ospo-book/content/en/07-chapter.md#L7
In general, use active voice instead of passive voice ('is updated').
"TODO.Contractions": ospo-book/content/en/07-chapter.md#L7
Use 'doesn't' instead of 'does not'.
"TODO.Parens": ospo-book/content/en/07-chapter.md#L7
Use parentheses judiciously.
"TODO.Passive": ospo-book/content/en/07-chapter.md#L44
In general, use active voice instead of passive voice ('be added').
"TODO.Passive": ospo-book/content/en/07-chapter.md#L44
In general, use active voice instead of passive voice ('be removed').
"TODO.Contractions": ospo-book/content/en/00-chapter.md#L7
Use 'What's' instead of 'What is'.
"TODO.Contractions": ospo-book/content/en/00-chapter.md#L13
Use 'It's' instead of 'It is'.
"TODO.Contractions": ospo-book/content/en/00-chapter.md#L22
Use 'doesn't' instead of 'does not'.
"TODO.Contractions": ospo-book/content/en/00-chapter.md#L24
Use 'doesn't' instead of 'does not'.
"TODO.Contractions": ospo-book/content/en/toc.md#L9
Use 'they're' instead of 'they are'.