-
Notifications
You must be signed in to change notification settings - Fork 60
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
Conversation
👷 Deploy request for avo-v2-docs pending review.Visit the deploys page to approve it
|
There was a problem hiding this 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 the3.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
Thank you for the speedy review @Paul-Bob! |
There was a problem hiding this 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 !
This adds documentation related to avo-hq/avo#3516