Skip to content

docs: fix docs typos and example issues for issue 725#764

Open
vaquarkhan wants to merge 1 commit into
apache:mainfrom
vaquarkhan:issue-725-doc-fixes
Open

docs: fix docs typos and example issues for issue 725#764
vaquarkhan wants to merge 1 commit into
apache:mainfrom
vaquarkhan:issue-725-doc-fixes

Conversation

@vaquarkhan
Copy link
Copy Markdown
Contributor

@vaquarkhan vaquarkhan commented May 8, 2026

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

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

fixed #725

@github-actions github-actions Bot added area/website burr.apache.org website area/examples Relates to /examples labels May 8, 2026
@vaquarkhan
Copy link
Copy Markdown
Contributor Author

Hi @skrawcz PR is ready for review

Comment thread README.md
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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why remove the emoji?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

TIL - thanks!

Copy link
Copy Markdown
Contributor

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

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

I'd leave the emoji in -- otherwise looks good

@skrawcz skrawcz enabled auto-merge (squash) June 6, 2026 20:56
@skrawcz
Copy link
Copy Markdown
Contributor

skrawcz commented Jun 7, 2026

@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.
auto-merge was automatically disabled June 7, 2026 01:07

Head branch was pushed to by a user without write access

@vaquarkhan vaquarkhan force-pushed the issue-725-doc-fixes branch from d577136 to 0449f0c Compare June 7, 2026 01:07
@vaquarkhan
Copy link
Copy Markdown
Contributor Author

@skrawcz done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/examples Relates to /examples area/website burr.apache.org website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation typos, broken code examples, and remove decorative emoji

2 participants