Skip to content

Comments

docs-lint passing#8

Merged
freakboy3742 merged 4 commits intobeeware:mainfrom
kattni:tooling/docs-linting
Jan 27, 2026
Merged

docs-lint passing#8
freakboy3742 merged 4 commits intobeeware:mainfrom
kattni:tooling/docs-linting

Conversation

@kattni
Copy link
Collaborator

@kattni kattni commented Jan 24, 2026

Addresses "Docs linting" section in #4.

Verifies all links, satisfies pyspelling.

Regarding pyspelling:

  • Applies <nospell> to words unlikely to be reused often.
  • Includes words likely to be used often in spelling_wordlist.
  • Includes all author IDs in .authors.yml in spelling_wordlist to handle being able to parse the YAML frontmatter in the event/resource posts, as the descriptions in there should be spellchecked, but it was failing on the author IDs. NOTE: The spellchecker only gets as far as the first digit in the GitHub ID, so some of the list appears truncated; it is.

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

@kattni kattni marked this pull request as draft January 24, 2026 07:24
@kattni kattni marked this pull request as ready for review January 25, 2026 07:24
@kattni kattni requested a review from freakboy3742 January 25, 2026 07:25
@kattni kattni changed the title WIP: docs-lint passing docs-lint passing Jan 25, 2026
Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 A lot of changes (a lot of them very embarrassing...) but mostly straightforwards.

@freakboy3742 freakboy3742 merged commit e1dd552 into beeware:main Jan 27, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants