Commit Graph
47 Commits
Author SHA1 Message Date
Angelico 399de888d5 Updating Documentation for .rpc()
- Documentation for new filters is now complete.
2020-04-09 09:06:26 +08:00
Angelico 72a7b3c1c0 Updating Documentation for .update() & .delete()
- plus minor corrections
2020-04-08 21:58:21 +08:00
Angelico 0e28187f64 Starting Documentation for New Filters
- For all new filters introduced in postgrest-js 0.12.0
- Started with .select() first, the rest should be quicker from here.
- Took the liberty as well to group common snippets as well to minimise surface area.
- Surface area of examples could be further reduced.
2020-04-08 19:10:04 +08:00
Angelico 78fc0339c1 Update Documentation for .neq()
- Convert all past .not() to .neq()
- Delete docs/common/CommonFilters.mdx, which has already been made redundant by docs/common/filters & docs/common/CommonFilters.js
2020-04-08 11:16:17 +08:00
Paul Copplestone 78aa4ef4b0 Updates Docusaurus to latest, with all realevant updates for our overrides 2020-04-02 12:15:14 +08:00
Angelico 8e0f81debd #44 Update documentation for upsert 2020-03-24 15:26:24 +08:00
Paul Copplestone e740eeb79d Merge branch 'master' of github.com:supabase/supabase 2020-03-16 18:47:32 +08:00
Paul Copplestone 0cfaeb23fb Initialises the common snippets library 2020-03-16 18:47:27 +08:00
Angelico 0926fb6b45 RPC examples for #21
plus minor clean ups on documentation.
2020-03-16 12:36:47 +08:00
Angelico b68685403c Delete examples for #21 2020-03-11 20:34:32 +08:00
Angelico 63038efe7a Patch examples for #21 2020-03-11 20:26:42 +08:00
Angelico bb7ab7e253 Get Examples for #21
- Creation of examples folder since the number of examples will just grow from here.
- Examples for Reading
2020-03-11 20:07:21 +08:00
awalias 7f0cc6f8e0 Merge branch 'master' of https://github.com/supabase/supabase 2020-02-18 18:57:22 +08:00
awalias 4953824951 udpated some typos 2020-02-18 18:57:15 +08:00
Angelico 7f5f0a5f67 Update response documentation for status code 201 & standardise responses 2020-02-14 13:43:29 +08:00
Angelico 63c97da22b Update documentation for .single() 2020-02-12 18:02:21 +08:00
Angelico 8314eeebe9 Boyscout: update documentation to reflect changes to @supabase/postgrest-js 2020-02-11 17:54:14 +08:00
Angelico 293587272d Update Documentation
The following changes were done:
- Add responses for subscribe.mdx, post.mdx, patch.mdx, delete.mdx, stored-procedures.mdx.
- Clean up of repeated information.
2020-01-28 15:44:39 +08:00
awalias 18e026abd7 adding decriptions to docs to mitigate og:description issue #10 2020-01-27 11:43:02 +08:00
Angelico a89696ab6e Boyscout Commit
The following changes were done:
- @supabase/supabase-js version bump.
- Set default value for functionParameters in supabase.rpc() to be null, making it an optional parameter.
- Minor changes to examples responses for Stored Procedures documentation to make it more accurate.
2020-01-27 00:25:45 +08:00
Copple 0713fdfba4 Cleans up a lot of issues covered in #9. Specifically:
- A better way of toggling example responses
- Added an example where users can query the same foreign table twice
- fixed the 'filter()' example
2020-01-24 16:06:57 +08:00
Paul Copplestone 7a39c85309 Fixing foreign key selects 2020-01-23 18:33:12 +08:00
Angelico 3677d741f2 Boyscout: fix formatting for return values of realtime events 2020-01-21 13:52:47 +08:00
Paul Copplestone 0dc6e24089 Kaizen: get example missing select() 2020-01-20 10:08:53 +08:00
Copple 1a6a714d15 Cleaning up the manifesto 2020-01-14 14:52:39 +08:00
Copple 462c7a7577 Adding some of the params 2020-01-14 14:42:28 +08:00
Copple 696857c678 Updating stored procedures 2020-01-14 14:27:33 +08:00
Angelico 2df761a28c Clean up Documentation
The following changes were made:
- Edit all reference to api endpoints from supabase.io to supabase.co.
- Clean up function calls for .update(), insert() and .delete().
2020-01-14 11:50:30 +08:00
Angelico 8a483b7412 Write Documentation for Stored Procedures
The following changes were made:
- Write documentation for stored procedures under the file stored-procedures.mdx.
- Add stored-procedures.mdx into the sidebar.
2020-01-14 11:16:35 +08:00
Angelico 40cea1c5dd Changes to RESTful Documentation
The following changes were made:
- Edited and cleaned up get.mdx, post.mdx, patch.mdx and delete.mdx based on latest changes.
2020-01-14 10:13:20 +08:00
Angelico a95f262e9d Further Changes to Documentation
The following changes were made:
- Clean up getting-started.mdx for better formatting.
- Edited and cleaned up subscribe.mdx based on latest changes.
- Introduced from() to all.
2020-01-14 08:59:36 +08:00
Angelico a03890da3e Rewrite Component for CommonFilters
The following were done:
- Refactor CommonFilters to allow filters to appear on Contents.
- Change documentation of how filter functions are invoked based on new changes.
2020-01-13 13:22:51 +08:00
Paul Copplestone 1838c352e1 Laying out a new way of doing filters so that they appear on the sidebar 2020-01-13 09:42:53 +08:00
Paul Copplestone 876dd19149 Adding just two options 2020-01-11 16:11:16 +08:00
Paul Copplestone d2698d22ea Docs reviewed with Ant. One change remains: we should be putting the REST verbs at the end of the chain for readability. 2020-01-09 17:44:28 +08:00
Paul Copplestone 66529db840 Finishing of updates/deletes/creates 2020-01-08 15:48:08 +08:00
Copple d0356a832a Kaizen: reordering elements for readability 2020-01-08 13:14:21 +08:00
Copple a050f9be2c Removing all the unneccessary items from our docs. We might need it later on. But we don't for now... 2020-01-08 12:51:46 +08:00
Paul Copplestone 182959b346 Making the documentation a lot clearer. As Antoine says - perfection is attained, not when there is nothing more to add, but when there is nothing left to take away 2020-01-07 19:05:13 +08:00
Angelico 5b08a4344f Complete Documentation for subscribe
The following were done:
- Complete subscribe.mdx.
- (Boyscout) Change one line of a code snippet in post.mdx for consistency.
2020-01-07 08:50:55 +08:00
Angelico 87b874ffe7 Refinement of Documentation
The following were done:
- Begin writing documentation under subscribe.mdx (WIP)
- Refine documentation for get.mdx, patch.mdx and delete.mdx to match the standard of post.mdx
2020-01-06 14:22:12 +08:00
Angelico fda3aa9419 Complete Documentation for Update & Delete Rows
The following were done:
- Complete delete.mdx and patch.mdx.
- (Boyscout) Change one sentence in about.md.
- Reroute internal links due to the restructuring of the library section in the previous commit.
2020-01-06 11:04:49 +08:00
Angelico 5f8f3055bd Refinement of Documentation
General changes on the following:
- Change data type for parameter of .select function from array to string.
- Restructure library section of documentation to give it a flat structure.
2020-01-06 08:14:37 +08:00
Angelico f312193ea1 Complete Documentation for Reading Rows
The following were done:
- Complete get.mdx
- Refine filters.mdx and post.mdx
2020-01-03 18:36:52 +08:00
Angelico b3b34c15fc Write Documentation for Generic RESTful Features
The following were done:
- Create and complete filters.mdx, options.mdx and responses.mdx to document generic RESTful features.
- Edit sidebars.js to accomodate the above-mentioned change.
- Refine documentation format via getting-started.mdx and post.mdx
2020-01-03 17:08:46 +08:00
Angelico dd3033b7d1 Refinement of Documentation
The following were done:
- Change sidebar configuration to remove redundant documentation.
- Change titles of RESTful .mdx files to better reflect CRUD.
- Comment out (not delete) resources for now as we do not have any content for it at the moment.
- Complete initial documentation for creating rows under the RESTful feature.
- Refine documentation for getting-started.mdx
2020-01-03 10:46:19 +08:00
Angelico c45cdd681b Restructure Documentation
Change general documentation structure to make it more readable and organised. Further categorise .mdx files to make it clearer as to which feature each file is referring to.
2020-01-02 16:38:04 +08:00