Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation: add grids, tables to make intro info easier to digest #276

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Documentation: add grids, tables to make intro info easier to digest #276

wants to merge 10 commits into from
+74 −17

Conversation

sydney-runkle
Copy link
Member

@sydney-runkle sydney-runkle commented Dec 16, 2024 •
edited
Loading

  • More engaging "why PydanticAI" section with icons and headings
  • Move glossary on agents page to tabular format

Before:
Screenshot 2024-12-17 at 9 21 04 AM

After:
Screenshot 2024-12-17 at 6 48 56 PM

Before:
Screenshot 2024-12-17 at 9 22 32 AM

After:
Screenshot 2024-12-17 at 9 22 21 AM

hyperlint-ai[bot]
hyperlint-ai bot reviewed Dec 16, 2024
View reviewed changes
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

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

The style guide flagged several spelling errors that seemed like false positives. We skipped posting inline suggestions for the following words:

  • Pydantic
  • Groq
  • Logfire
  • [Vv]alidators
  • Ollama

@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

cloudflare-workers-and-pages bot commented Dec 16, 2024 •
edited
Loading

Deploying pydantic-ai with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2f6af01
Status: ✅  Deploy successful!
Preview URL: https://376abe9e.pydantic-ai.pages.dev
Branch Preview URL: https://docs-update-ease-of-use.pydantic-ai.pages.dev

View logs

@sydney-runkle
Copy link
Member Author

TODO in a future PR, wanted to go ahead and get this across the line :)

  • Break up complicated example into more digestible parts
  • Provide more context for each example, moving some information out of code annotations
  • Add admonitions giving context to agent framework terminology + linking to the relevant conceptual section
  • Add more Pydantic Logfire context

@sydney-runkle sydney-runkle marked this pull request as ready for review December 17, 2024 14:20
@sydney-runkle sydney-runkle changed the title Draft: Improving Intro Docs Page Documentation: add grids, tables to make intro info easier to digest Dec 17, 2024
@sydney-runkle sydney-runkle added the documentation Improvements or additions to documentation label Dec 17, 2024
samuelcolvin
samuelcolvin reviewed Dec 17, 2024
View reviewed changes
docs/agents.md Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
summerscope
summerscope requested changes Dec 17, 2024
View reviewed changes
Copy link
Contributor

@summerscope summerscope left a comment

Choose a reason for hiding this comment

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

Looking good, let's try to make this list a bit tighter still

docs/agents.md Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hyperlint-ai hyperlint-ai[bot] hyperlint-ai[bot] left review comments

@samuelcolvin samuelcolvin samuelcolvin left review comments

@summerscope summerscope summerscope requested changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sydney-runkle @samuelcolvin @summerscope