Skip to content

Docs improvements - #1162

Merged
audreyfeldroy merged 12 commits into
feldroy:mainfrom
MrValdez:docs-improvements
Aug 11, 2026
Merged

Docs improvements#1162
audreyfeldroy merged 12 commits into
feldroy:mainfrom
MrValdez:docs-improvements

Conversation

@MrValdez

Copy link
Copy Markdown
Contributor

What

This is a collection of doc improvements and edits from the point of view of a new user.

Pattern

N/A

Reviewer Focus

  • Consistency was applied to the examples
  • Updated the examples
  • Fixed some broken examples
  • Added an alternate way to pass reserved words.

Checklist

  • Diff contains only changes for this task — no unrelated refactoring or cleanup
  • Addresses exactly one issue or feature
  • New or changed behavior has test coverage
  • This is the simplest viable approach
  • AI provenance section removed or accurate

@audreyfeldroy audreyfeldroy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Very thoughtful work @MrValdez, thank you!

Comment thread docs/api/routing.md

```python
# cart.py
```python title="cart.py"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Whoa, didn't know about this, cool!

Comment thread docs/api/routing.md

@router.page
def cart():
def cart_page():

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Great catch

Comment thread docs/api/requests.md
air.Section(air.Aside({"username": form.get("username")}))
air.Section(
air.Aside({"username": form.get("username")}),
),

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I take it this reduces cognitive load / friction for new users? @MrValdez

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah, as I read through the rest of the diff I could see it feels better with the spacing.

Comment thread docs/learn/air_tags.md
Alternately, we can pass reserved keywords as kwargs.

```python
air.Label("Email", **{"class": "plain", "for": "email"})

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I like it :)

Comment thread docs/learn/air_tags.md Outdated
Comment thread README.md Outdated

@audreyfeldroy audreyfeldroy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Applied the requested documentation changes and verified the branch after updating from main.

@audreyfeldroy
audreyfeldroy merged commit 195df0d into feldroy:main Aug 11, 2026
8 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