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

README documentation improvement #16

Open
FTLam11 opened this issue Oct 4, 2022 · 0 comments
Open

README documentation improvement #16

FTLam11 opened this issue Oct 4, 2022 · 0 comments

Comments

@FTLam11
Copy link
Contributor

FTLam11 commented Oct 4, 2022

Context

While using this gem to build out the KOMOJU card project, there were some things we noticed that weren't so obvious. To help out the next developer that uses this gem, here are some documentation improvements:

  • In the example for page.rb, we should suggest the developer to implement the authorization checks their page requires
  • Include a message about mixing options + composition API in Vue components - note the approach used with Vue ref API
  • Open a new feature request for supporting other HTTP verbs like PATCH
  • Add docs for performing different requests on the page
  • Add docs for importing the page pack
  • Add docs for localization
  • Discuss different options for testing page.rb - feature/controller
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

No branches or pull requests

1 participant