initial conversion of accessibility page from rst to myst - #1406
Conversation
|
Now that I can see the changes here - I wonder what's the real difference here? Links are still strange syntax, directives are still a strange syntax. Is all this work really just so heading are slightly easier? What else are we gaining by all of this? |
c5506d8 to
d39dd30
Compare
I think the biggest thing we gain is that people are much more likely to have prior experience with markdown, and so many of the smaller formatting/content changes can be made by community members without them needing to explore the all the myst syntax extensions. So while headers, italics, bolds, and code blocks might feel like a minor improvement, that easily covers most of the changes people will want to make, and they will be able to do so using existing intuition instead of running into difficulty with doing the same simple formatting through rst. Even core team members (I for one) have had difficulty with formatting in rst, so this is a substantial win for everyone. Ultimately I think the myst solution is a great direction because it seems to understand the different audiences and contributors who the documentation source is for. A novice contributor wants something familiar and approachable, while the core developers are willing to learn something complex to avoid repetition and keep things maintainable. As seen in this PR, Myst will allow us to keep all of our existing tools and structures that we like to use, while making the actual content formatting more approachable to a general audience. Other proposals, like MkDocs, would have required moving to pure markdown syntax and sacrificing links and directives. So this is a compromise that (IMO) has the potential to address the biggest needs of both groups. Definitely open to any feedback or alternative suggestions on how we could satisfy those two groups better! |
|
I had to add 'html' to the spelling list for the internal link |
From the docs https://sphinxcontrib-spelling.readthedocs.io/en/latest/customize.html there appears to be patterns we can ignore, but I think it's fine to just add
|
Contributes to #1401 and fixes OSC/ood-documentation-build#26. This PR will only work if you open and build the updated container in OSC/ood-documentation-build#27. With that container, this change adds myst_parser to the sphinx extensions in
conf.pyand demonstrates the conversion from rst to myst syntax. I started with the accessibility page as it was quite short while still demonstrating how titles, links, and more complex structures like inclusions get handled in myst.Some notes
refstill function, the only difference is the demarkation (braces instead of colons)'wcag'_definition in accessibility_settings.inc, which could then be used by any parent file that included it. With myst, it is reversed so that the included file can use links defined in parent files, but not vice versa.