docs-lint passing (#8)

Co-authored-by: Russell Keith-Magee <[email protected]>

Author: kattni

.pyspelling.yml

@@ -1,5 +1,16 @@
 matrix:
 - name: markdown
+  hunspell:
+    d: en_US
+  aspell:
+    lang: en
+    d: en_US
+    mode:
+      - markdown
+      - url
+      - email
+    ignore-case: true  # I'm not sure this is doing anything.
+    ignore-accents: true  # I'm not sure this is doing anything.
   dictionary:
     wordlists:
     - docs/spelling_wordlist
@@ -17,6 +28,7 @@ matrix:
       - pymdownx.blocks.admonition
       - pymdownx.blocks.caption
       - pymdownx.blocks.tab
+      - pymdownx.details
   - pyspelling.filters.html:
       comments: true
       attributes:
@@ -25,24 +37,35 @@ matrix:
       ignores:
         - 'code'
         - 'pre'
+        - 'div'
+        - 'a'
         - 'nospell'
+        - 'script'
   - pyspelling.filters.context:
       context_visible_first: true
-      escapes: '\\[\\`~]'
+#      escapes: '\\[\\`~]'
       delimiters:
         # Ignore the Jinja directives
-        - open: '{%'
-          content: '[\d\D]*'
-          close: '%}'
+        - open: '{% '
+          close: ' %}'
         # Ignores the autorefs link targets
         - open: '\]\['
-          content: '[\d\D]*'
           close: '\]'
         # Ignore the single line Snippets syntax
-        - open: '-8<\-'
-          content: '[\d\D]*'
-          close: '\n'
-        # Ignore the multiline Snippets syntax
-        - open: '-8<\-\n'
-          content: '[\d\D]*'
-          close: '-8<-\n'
+        - open: '-8<- '
+          close: '$'
+        # Ignore the .md URLs - appears to be fixed by mode: url above
+        #- open: 'https?:'
+        #  close: '\.md(:[-\w]+)?'
+        # Ignore urls in frontmatter - This is still necessary with mode: url
+        - open: 'url: '
+          close: '$'
+        # Ignore toc in frontmatter
+        - open: '- toc'
+          close: '$'
+        # Ignore numbers with a suffix, e.g. dates
+        - open: '[0-9]+'
+          close: '[rshndt]*'
+        # Ignore version numbers - TODO: verify this does what I think it does
+        - open: '[0-9\.]+[a-z]*'
+          close: '[0-9]*'

docs/en/about/history.md

@@ -14,7 +14,7 @@ And so, we're left with an interesting schism, between the "old way" of Unix dev
 
 ### The Unix Philosophy
 
-However, it doesn't have to be that way. The core tenet of the Unix Philosophy is that "each tool does one thing, well". This is a very powerful philosophy, and it enables the composition of extremely powerful toolchains by putting together a suite of extremely focussed, independent tools.
+However, it doesn't have to be that way. The core tenet of the Unix Philosophy is that "each tool does one thing, well". This is a very powerful philosophy, and it enables the composition of extremely powerful toolchains by putting together a suite of extremely focused, independent tools.
 
 Unfortunately, most UNIX tools have convolved this to also mean "all tools must use a console interface". However, there's nothing in the UNIX philosophy that says that tools have to use a console interface - it's just turned out that way.
 
@@ -30,13 +30,13 @@ Even then, it's easy to think of a project in a vacuum, as the sum of all contri
 
 A diverse community is a strong community. This means accepting people of all levels of experience, from all backgrounds, of all races, creeds, orientations and expressions. The BeeWare project is committed to developing and maintaining a inclusive, diverse and welcoming community.
 
-To back this up, we have an open offer to mentor anyone who wants to get involved as a contributor, and a [Code of Conduct](/community/code-of-conduct.md) that is rigorously enforced. Any reports of violations of that code of conduct - even by senior community members - will be treated with respect and actioned appropriately.
+To back this up, we have an open offer to mentor anyone who wants to get involved as a contributor, and a [Code of Conduct](/community/code-of-conduct.md) that is rigorously enforced. Any reports of violations of that code of conduct - even by senior community members - will be treated with respect and acted upon appropriately.
 
 ### Healthy and sustainable
 
 It's also important to make sure that the community is accessible and sustainable. It's unfortunately become an accepted part of Open Source culture that "true" Open Source projects have to be developed entirely by volunteers. This acts as a barrier to entry for many groups - the only people able to spend their free time volunteering are those that *have* free time.
 
-It also frequently leads to burnout and other mental health issues amongst contributors. The fact that depression, anxiety, and burnout are so common in software development communities shouldn't be considered a badge of honour, or a demonstration of how committed a development team can be. It's a problem that needs to be tackled head on, and addressed in the same way a software bug would be addressed - with immediate workarounds, and long term plans to remove the systemic cause of the problem.
+It also frequently leads to burnout and other mental health issues amongst contributors. The fact that depression, anxiety, and burnout are so common in software development communities shouldn't be considered a badge of honor, or a demonstration of how committed a development team can be. It's a problem that needs to be tackled head on, and addressed in the same way a software bug would be addressed - with immediate workarounds, and long term plans to remove the systemic cause of the problem.
 
 While we place incredible value on the contributions of volunteers, we also know that volunteer efforts alone aren't the way to develop a healthy and sustainable community. For that reason, financial sustainability is a key consideration in the operation of the BeeWare project. As a community, we don't ignore the role that money has to play in providing the resources that allows people to begin and continue to contribute. We will, as a community, provide accepted mechanisms for individuals to monetize their work in meaningful ways, and wherever possible, compensate people for their work - without compromising the ideals of Open Source development.
 

docs/en/about/team/cflee.md

@@ -1,3 +1,3 @@
-Chiang Fong has been pretending to be a systems administrator since the Mandriva Linux days, and has recently moved into acting like he knows how to write software.
+<nospell>Chiang Fong</nospell> has been pretending to be a systems administrator since the <nospell>Mandriva</nospell> Linux days, and has recently moved into acting like he knows how to write software.
 
 When not poking at code to de-stress, he spends his time fiddling with fountain pens and mechanical keyboards. He has yet to learn the lesson of not mixing inky fingers with pretty keycaps.

docs/en/about/team/flowerncsu.md

@@ -1 +1 @@
-Charlotte has been coding for more years than she likes to admit, and has a passion for building cool things and helping other people learn how to build cool things. She is among the organizers of PyLadies RDU, and can often be found making things out of yarn when not making things out of code.
+Charlotte has been coding for more years than she likes to admit, and has a passion for building cool things and helping other people learn how to build cool things. She is among the organizers of PyLadies <nospell>RDU</nospell>, and can often be found making things out of yarn when not making things out of code.

docs/en/about/team/obulat.md

@@ -1,3 +1,3 @@
-Olga is a python and BeeWare enthusiast, also interested in NLP, geography and languages.
+Olga is a python and BeeWare enthusiast, also interested in <nospell>NLP</nospell>, geography and languages.
 
 She also enjoys hanging out with kids.

docs/en/about/team/phildini.md

@@ -1 +1 @@
-Philip writes code for computers and for humans. His first computing love is Python, but is too often forced to write JavaScript and Swift. When he's not writing code for money or for Open Source or for his own crazy projects, he gives talks at conferences. Philip lives in Alameda, California with his wife and her cat. Philip believes in the web.
+Philip writes code for computers and for humans. His first computing love is Python, but is too often forced to write JavaScript and Swift. When he's not writing code for money or for Open Source or for his own crazy projects, he gives talks at conferences. Philip lives in <nospell>Alameda</nospell>, California with his wife and her cat. Philip believes in the web.

docs/en/about/team/samschott.md

@@ -1 +1 @@
-Sam is a physicist and a software engineer. He got introduced to Python while automating data acquisition in the lab and soon realised that he enjoyed writing and sharing code. When away from a computer, you will find him hiking or sailing along the English coast.
+Sam is a physicist and a software engineer. He got introduced to Python while automating data acquisition in the lab and soon realized that he enjoyed writing and sharing code. When away from a computer, you will find him hiking or sailing along the English coast.

docs/en/about/team/saroad2.md

@@ -1 +1 @@
-Sagi Shadur is a software engineer and a mathematician. He has a B.Sc. in mathematics and these days he's on his way for a second B.Sc. in physics. He's also a poet who published two books in Hebrew, "Mountains and Valleys" and "The Emissary".
+<nospell>Sagi Shadur</nospell> is a software engineer and a mathematician. He has a B.Sc. in mathematics and these days he's on his way for a second B.Sc. in physics. He's also a poet who published two books in Hebrew, "Mountains and Valleys" and "The Emissary".

docs/en/community/code-of-conduct.md

@@ -1,6 +1,6 @@
 
---8<-
+-8<-
 
 https://raw.githubusercontent.com/beeware/.github/refs/heads/main/CODE_OF_CONDUCT.md
 
---8<-
+-8<-

docs/en/community/governance.md

@@ -23,7 +23,7 @@ Founding Apiarist: [Russell Keith-Magee](/about/team.md#freakboy3742)
 - This role is different to the BDFN role
 
 Bee-nevolent Dictator for Now (BDFN): [Russell Keith-Magee](/about/team.md#freakboy3742)
-- A take on [Benevolent Dictator for Life](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life), responsibility for the direction and decisions of the project ultimately lies with the BFDN. The use of "For Now" as opposed to "For Life" is reference to the Django theme of not subjecting the responsibilities of core maintainer for a person's entire natural life. Life exists outside open source, and code/life balance and general well-being is a very important thing to keep in mind.
+- A take on [Benevolent Dictator for Life](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life), responsibility for the direction and decisions of the project ultimately lies with the BDFN. The use of "For Now" as opposed to "For Life" is reference to the Django theme of not subjecting the responsibilities of core maintainer for a person's entire natural life. Life exists outside open source, and code/life balance and general well-being is a very important thing to keep in mind.
 
 ## Guidelines (not actual rules)