-
Notifications
You must be signed in to change notification settings - Fork 24
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
Arranger Dev Documentation Update #892
base: main
Are you sure you want to change the base?
Conversation
6b33e90
to
7f882d1
Compare
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.
that's my ¢2
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.
lots of impressive work! serious upgrade and much needed update.
also happy with how user friendly the guides are now. thank you!
left a few comments with my thoughts as I read through it all, for your consideration
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 pretty good! I like this guide, well done!
|
||
Arranger uses a custom filter notation SQON (Serializable Query Object Notation, pronounced like "Scone") to provide a flexible system for combining filters in a JSON object format. | ||
|
||
- A SQON object consists of two types of nested objects, **Value Objects** and **Operation Objects**. |
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.
I think using "object" so repeatedly will quickly lead to semantic satiation, and that we can rephrase this later on using other more descriptive terms like "entity" and "type"
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Easiest to read from the docs site here. File names will match closely to the URL structure
Readme.md
file.contributing
filecode_of_conduct
filelicense.md
file/docs
folder with the following structure:Important
Before going live will need to update any links to the demo discussion board and Netlify deploy preview
Notes for reviewers