docs: fix docs typos and example issues for issue 725#764
Conversation
|
Hi @skrawcz PR is ready for review |
| Link to [documentation](https://burr.apache.org/). Quick (<3min) video intro [here](https://www.loom.com/share/a10f163428b942fea55db1a84b1140d8?sid=1512863b-f533-4a42-a2f3-95b13deb07c9). | ||
| Longer [video intro & walkthrough](https://www.youtube.com/watch?v=rEZ4oDN0GdU). Blog post [here](https://blog.dagworks.io/p/burr-develop-stateful-ai-applications). Join discord for help/questions [here](https://discord.gg/6Zy2DwP4f3). | ||
|
|
||
| ## 🏃Quick start |
There was a problem hiding this comment.
Here is a quick summary of why we removed decorative emojis from the documentation:
-
ASF & Accessibility Standards: Decorative emojis in section headers disrupt screen readers (which read the literal emoji name aloud) and break document navigation. Removing them aligns with W3C/WCAG accessibility guidelines and Apache Software Foundation (ASF) project standards.
-
Markdown Accessibility Guidelines: https://accessibility.github.com/documentation/guide/getting-started-with-agents/ (Explicitly warns against decorative emojis in headers)
If you can still see issue I will.add back emoji and will give new pr to only broken fix .plz advice
skrawcz
left a comment
There was a problem hiding this comment.
I'd leave the emoji in -- otherwise looks good
|
@vaquarkhan can you rebase? can't seem to merge because of the validation... |
Correct broken snippets and grammar, fix RST formatting issues, and remove decorative emoji from documentation headers for consistency with project standards.
Head branch was pushed to by a user without write access
d577136 to
0449f0c
Compare
|
@skrawcz done |
Correct broken snippets and grammar, fix RST formatting issues, and remove decorative emoji from documentation headers for consistency with project standards.
[Short description explaining the high-level reason for the pull request]
Changes
How I tested this
Notes
Checklist
fixed #725