docs: improve examples README and fix grammar in intro notebook#1540
Open
mitre88 wants to merge 1 commit intoairweave-ai:mainfrom
Open
docs: improve examples README and fix grammar in intro notebook#1540mitre88 wants to merge 1 commit intoairweave-ai:mainfrom
mitre88 wants to merge 1 commit intoairweave-ai:mainfrom
Conversation
- Add missing documentation for intro_to_airweave.ipynb, search_concepts.ipynb, and webhook-demo/ to the examples README - Fix grammar: 'is an open-source platform enables' → 'is an open-source platform that enables' - Fix grammar: 'as many or as little sources' → 'as many or as few sources' - Fix grammar: 'Once source connection' → 'Once the source connection' - Improve formatting of setup instructions in the intro notebook
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the developer enablement materials in the
examples/directory:Examples README (
examples/README.md)The README previously only documented
quickstart_tutorial.py, but the directory also contains two Jupyter notebooks and a webhook demo subdirectory. This PR adds documentation for:intro_to_airweave.ipynb— Description and overview of what new users will learnsearch_concepts.ipynb— Summary of all 14 search examples covered in the notebookwebhook-demo/— Cross-reference to the webhook demo subdirectoryIntro Notebook (
examples/intro_to_airweave.ipynb)Fixed several grammar and formatting issues:
is an open-source platform enables→is an open-source platform that enablesas many or as little sources→as many or as few sources(countable noun)Once source connection is established→Once the source connection is establishedChanges
examples/README.mdexamples/intro_to_airweave.ipynbNo code changes.
Summary by cubic
Improves the examples README to document the intro and search notebooks plus the webhook demo, and cleans up grammar/formatting in the intro notebook. No code changes.
Written for commit d11ea7a. Summary will update on new commits.