Skip to content

Raphael/modus search #44

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

Merged
merged 9 commits into from
Oct 8, 2024
Merged

Raphael/modus search #44

merged 9 commits into from
Oct 8, 2024

Conversation

rderbier
Copy link
Member

@rderbier rderbier commented Oct 6, 2024

initial draft for discussion and clarification.

Open TO DOs
TO DO: < add an explanation for testing from GraphQL API>

Should we describe how to add data which is part of testing your search?

Sample code requires more comments.

Link to function-as and function-go samples ?

Should we add a "What next" section and introduce clustering classification etc ...

@rderbier rderbier requested a review from a team as a code owner October 6, 2024 00:03
@ryanfoxtyler
Copy link
Member

I've updated the vocabulary to address common errors, but please run trunk fmt + trunk check and address any issues before marking for review. Setting to draft.

@ryanfoxtyler ryanfoxtyler marked this pull request as draft October 6, 2024 23:47
@rderbier rderbier marked this pull request as ready for review October 7, 2024 17:26
@ryanfoxtyler
Copy link
Member

merging and we'll massage amongst the broader branch

@ryanfoxtyler ryanfoxtyler merged commit 734ce33 into modus-docs Oct 8, 2024
0 of 3 checks passed
@ryanfoxtyler ryanfoxtyler deleted the raphael/modus-search branch October 8, 2024 11:50
ryanfoxtyler added a commit that referenced this pull request Oct 22, 2024
* set up structure for Modus

* Update mint.json

* update top buttons

* Update mint.json

* add anchors

* Update mint.json

* Update mint.json

* Update mint.json

* not done yet

* add notes

* Update mint.json

* add notes

* formatting

* vocab updates

* create proj init

* fix links

* add csv import

* modify project init

* remove create org mention

* project slug validation

* only use save, not save changes

* delete project

* include project slug 31 character count

* add warning:

* modify organization

* an not a

* user management

* no active status

* graphql endpoint format

* Raphael/modus search (#44)

* Update search.mdx

draft and notes

* update draft

* Update search.mdx

* Update search.mdx

* initial draft

* correct vale errors

* correct go code spaces instead of tabs

* correct passive sentence

---------

Co-authored-by: Ryan Fox-Tyler <60440289+ryanfoxtyler@users.noreply.github.com>

* sentence case

* add some links

* more sentence case

* remove passive voice

* make up create project flow

* remove ci cd

* lowercase a

* add emphasis

* use components

* fix spacing

* hyp develop section (#46)

* hyp develop section draft

* run trunk fmt

* update vocab and run fmt

* Update api-generation.mdx

add similar example in AS and Go.
Expain export and public.
Remove Hypermode specifics.
Show a non exported function in the example.

* Update community-and-support.mdx

* finish first draft for model-invoking, fix outdated info (#45)

* 0.1 intro

* formatting

* add use cases

* first draft for hosted models (#47)

* remove warning

* updates

* more changes

* Hypermode Develop ✅

* Update accept.txt

* Update work-locally.mdx

* Update accept.txt

* Update hosted-models.mdx

* more updates

* Update accept.txt

* add npm install

* words

* Update modify-project.mdx

* formatting again

* Update modify-project.mdx

* add hyp-cli commands (#49)

* Modus/error handling (#48)

error handling using console and throw explained for AS and Go.

TO DO
explain “structure logging” better.

build_id → how can I use this info? Why is it relevant to me?
execution_id
plugin
text
user_visible → does it mean it will be in the GraphQL errors section?

* Update collections.mdx

Expand the description to explain the purpose of the Collections
Make the link to example more actionable and provide a description of what to expect (Example description).
Try to clarify description ( upsert for example).
Clarify "defaults to an empty namespace if not provided"
Change "to associate with the item" for get and search function: we don't associate a namespace when doing queries.
Misc clarification.

* Update collections.mdx

correct link to example add example for GoLang

* Update link to modus/sdk/assemblyscript/examples

+ correct broken links and 2 typos.

* Update modify-organization.mdx

* Update accept.txt

* Update quickstart.mdx

* hyp overview

* fix screenshot

* add alert, formatting

* Update user-management.mdx

* v0.1

* words

* formatting

* add images

* manage + addressing errors

* Hypermode cleanup

* Update quickstart.mdx

* configure prettier

* more updates

* more updates

* clearing final errors

* first manifest updates

* fix code formatting

* app manifest updates

* data fetching

* data fetching + narrow widths

* Auth docs (#51)

* add auth docs

* .:

* .

* Update data-fetching.mdx

use getPerson for Dgraph AS example to simplify code and align with Postgres example.

* Update data-fetching.mdx

update Dgraph Go example to match AS and Postgres simple example.

* Update data-fetching.mdx

correct Go example for Dgraph

* model invoking

* Update api-generation.mdx

* Update authentication.mdx

* changes on changes

* Update mint.json

* Update search.mdx

* Update quickstart.mdx

* Update quickstart.mdx

* Update data-fetching.mdx

addd http example.

* structure

* Update project-structure.mdx

* Update project-structure.mdx

* Update data-fetching.mdx

correct Go imports

* Update data-fetching.mdx

add GraphQL examples

* Update quickstart.mdx

* models

* more updates

* Update introduction.mdx

* Update error-handling.mdx

* Update data-fetching.mdx

remove location from postrgres example
test the quries and correct params
remove error handling

* Update data-fetching.mdx

Update tested version for Dgraph
simplify HTTP and GraphQL

* Update data-fetching.mdx

update GraphQL AS with tested code.

* fix trunk errors

* mintlify prettier config

* more formatting

* swap dependabot

* feedback

* Update mint.json

* readme and more formatting

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* move vale config

* Delete .github/workflows/vale.yml

* Update introduction.mdx

* Update CLI install

---------

Co-authored-by: Kevin Van Gundy <kvangundy@users.noreply.github.com>
Co-authored-by: Kristen Cheung <krcheung9@gmail.com>
Co-authored-by: Raphael <rderbier@gmail.com>
Co-authored-by: Pine <octref@gmail.com>
Co-authored-by: Kevin Mingtarja <69668484+kevinmingtarja@users.noreply.github.com>
Co-authored-by: Jai Radhakrishnan <55522316+jairad26@users.noreply.github.com>
Co-authored-by: Matt Johnson-Pint <mjp@hypermode.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants