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.

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

Add AI landing pages #674

Merged
merged 31 commits into from
Jan 24, 2025
Merged

Add AI landing pages #674

merged 31 commits into from
Jan 24, 2025

Conversation

valle-xyz
Copy link
Collaborator

@valle-xyz valle-xyz commented Jan 17, 2025

Ready to be merged.

  • This PR will add a section to the doc's home page that acts as a landing page and quickstart guides for participants of the Safe AI Agent hackathons.

Copy link

github-actions bot commented Jan 17, 2025

Branch preview

✅ Deployed successfully in branch deployment:

https://ai_landing_pages--docs.review.5afe.dev

Copy link

github-actions bot commented Jan 17, 2025

Overall readability score: 32.53 (🟢 +0.91)

File Readability
ai-advanced-setups.mdx 64.42 (-)
ai-agent-swaps-on-uniswap.mdx 79.7 (-)
ai-agent-swaps-with-cow-swap.mdx 79.57 (-)
introduction.mdx 90.14 (-)
agent-with-spending-limit.mdx 77.58 (-)
basic-agent-setup.mdx 79.13 (-)
human-approval.mdx 72.06 (-)
introduction.mdx 75.74 (-)
multi-agent-setup.mdx 68.33 (-)
ai-overview.mdx 25.35 (-)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
ai-advanced-setups.mdx 64.42 55.1 8.28 8.3 11.21 9.12
  - - - - - -
ai-agent-swaps-on-uniswap.mdx 79.7 67.86 7.91 7.2 8.92 6.72
  - - - - - -
ai-agent-swaps-with-cow-swap.mdx 79.57 74.39 8.75 7.6 8.46 6.67
  - - - - - -
introduction.mdx 90.14 77.64 6.5 6 6 6.55
  - - - - - -
agent-with-spending-limit.mdx 77.58 57.06 8.21 8.1 8.87 6.28
  - - - - - -
basic-agent-setup.mdx 79.13 73.58 8.59 7.5 7.88 7.15
  - - - - - -
human-approval.mdx 72.06 64.81 9.16 9.5 10.14 6.7
  - - - - - -
introduction.mdx 75.74 62.95 6.3 7.2 9.94 8.11
  - - - - - -
multi-agent-setup.mdx 68.33 57.16 9.52 9.4 10.37 7.22
  - - - - - -
ai-overview.mdx 25.35 27.72 14.12 17.7 17.46 9.76
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 32.53 28.33 13.56 17.17 15.56 8.93
  🟢 +0.91 🟢 +0.82 🟢 +0.1 🟢 +0.2 🟢 +0.15 🟢 +0.03
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@tanay1337 tanay1337 changed the title [Preview] AI langing pages [Preview] AI landing pages Jan 21, 2025
@valle-xyz valle-xyz changed the title [Preview] AI landing pages Add AI landing pages Jan 24, 2025
@valle-xyz valle-xyz added ready for DX review Ready for DX team to review and removed don't merge labels Jan 24, 2025
@valle-xyz valle-xyz requested a review from louis-md January 24, 2025 14:31
Copy link
Collaborator

@louis-md louis-md left a comment

Choose a reason for hiding this comment

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

Great work Valentin! 💪 Along with some minor edits, I have three remarks:

  • I will need more time to test that the code of these pages work; so I excluded it from the scope of this review for now.
  • While it is clever to publish these pages to showcase that we care about AI agents, I have doubts on the utility of these in the context of AI, as the quickstart guides are not specific to it. Whether you are an agent or a human does not make any difference here.
  • Most AI agents, models, and tooling are developed using Python (with the notable exception of LangChain which also includes some typescript tooling). I am not sure whether JS/TS guides will truly be helpful in the context of building these tools; on the contrary setting up a LangChain project (or similar) would be super cool to see how one could build an AI-powered app, with an agent having Safe capabilities.

These pages are useful in themselves (e.g. the one on spending limits or the ones on swaps), but they do not explain how to set up an AI agent with access to a Safe; only the javascript code that this agent will have to execute in order to interact with it.

pages/home/ai-overview.mdx Outdated Show resolved Hide resolved
pages/home/ai-agent-quickstarts/basic-agent-setup.mdx Outdated Show resolved Hide resolved
@valle-xyz
Copy link
Collaborator Author

Thanks @louis-md.

All of your comments are correct. For a Safe Smart Account it doesn't make a difference, who signs. However, we wanted to support AI builders not familiar with Safe to build.

@valle-xyz valle-xyz merged commit e0a04dc into main Jan 24, 2025
4 checks passed
@valle-xyz valle-xyz deleted the ai-landing-pages branch January 24, 2025 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for DX review Ready for DX team to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants