Documentation Updates

notchr2 years ago

8

• 

  jessrynkar2 years ago

  On it 🤓

• 

  notchr2 years ago

  Documentation | Styling

  (Opinion)

  
  
  

  Location: Any example

  
  
  

  Comments are styled very closely to brackets. This is maybe just me, but sometimes it's hard to differentiate.

  
  
  Documentation | Fields Overview
  https://payloadcms.com/docs/fields/overview
  
  

  Example should probably include the export of

  Page

  to stay consistent with other examples.

  
  
  Documentation | Fields Validation
  https://payloadcms.com/docs/fields/overview#validation
  
  

  Example should include export of

  Orders
  
  Documentation | Fields
  
  

  The following examples should include the export of

  Example Collection

  for consistency.

  
  
  

  All Fields.
• 

  jessrynkar2 years ago

  I'll check the export across the doc examples this seems like a lot of checking for you!!

• 

  notchr2 years ago

  Also, one last thing I noticed on the examples, I think the "Relationship" example should be shown inside of a collection maybe? So that the ExampleCollection pattern is consistent

• 

  jarrod_not_jared

  2 years ago

  I opened an issue to track these here:

  https://github.com/payloadcms/payload/issues/2594
• 

  notchr2 years ago

  Nice!! I'll post anything else I see!

  
  
  

  Also, over the weekend I built out a whole Vue3 + Payload example site with user auth setup

  
  
  

  Going to make a repo later and share it 😄

• 

  jessrynkar2 years ago

  Thank you for your attention to detail 🙏

  
  
  

  oh sick can't wait to take a look!

• 

  notchr2 years ago

  Of course!!

  
  
  

  Awesome, I cheated a bit on the typescript so it may neeed a few extra eyes haha