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 Documentation for Automatic Field Discovery #339

Merged
merged 4 commits into from
Jan 31, 2025

Conversation

ObiWanKeoni
Copy link
Contributor

@ObiWanKeoni ObiWanKeoni commented Jan 30, 2025

This adds documentation related to avo-hq/avo#3516

Copy link

netlify bot commented Jan 30, 2025

👷 Deploy request for avo-v2-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit e15e451

Copy link
Contributor

@Paul-Bob Paul-Bob left a comment

Choose a reason for hiding this comment

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

This is a solid base @ObiWanKeoni, thank you. We need to do some minor improvements before merging this PR:

  • Add VersionReq object with the 3.17.0 version on top of the page.
  • Use the Avo3 resource notation for all snipets for example class PostResource -> class Avo::Resources::Post
  • Add a commnet with the relative path on top of each snippet, for example for the post snippet: app/avo/resources/post.rb
  • Add some high lines on the important lines by adding {1,2-3} notation to each snippet (adjust the line numbers for each case}
  • Remove the demo link since is leading to a 404 for now

@ObiWanKeoni
Copy link
Contributor Author

Thank you for the speedy review @Paul-Bob!
I believe I've taken care of each of those - if you could re-review, that would be awesome

Copy link
Contributor

@Paul-Bob Paul-Bob 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!

<VersionReq version="3.17.0"> was missing the closing tag: <VersionReq version="3.17.0" /> and while fixing it I changed the version requirement syntax and also added a beta version tag.

Thank you @ObiWanKeoni !

docs/3.0/field-discovery.md Outdated Show resolved Hide resolved
@Paul-Bob Paul-Bob merged commit 63893d3 into avo-hq:main Jan 31, 2025
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