micro sdks docs #723
Open
micro sdks docs #723
Conversation
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
…styling - Introduced custom.js to manage sidebar navigation based on the current path. - Added style.css for potential navbar and footer styling adjustments.
- Introduced foundational concepts and best practices for using the @microfox/aws-ses SDK. - Added a getting started guide to help users configure AWS and send their first emails. - Documented the createSESSdk constructor and its usage. - Included detailed descriptions for sendEmail and sendBulkEmails functions, showcasing their parameters and usage examples.
- Introduced foundational concepts and detailed guides for using the @microfox/brave SDK, including installation and setup. - Added API references for key functions such as webSearch, imageSearch, videoSearch, newsSearch, and batchProcess. - Documented advanced features like middleware and batch processing, including examples and best practices for effective usage. - Created an overview section to highlight the SDK's capabilities and architecture.
- Introduced foundational concepts and best practices for using the @microfox/slack SDK, including design philosophy and handling API responses. - Added a getting started guide to help users install, configure, and build their first integration. - Documented key functions such as creating channels, messaging users, and managing reactions, with usage examples and parameter details. - Included an overview section highlighting the SDK's capabilities and architecture.
- Introduced foundational concepts of Retrieval-Augmented Generation (RAG) and advanced usage of the @microfox/rag-upstash SDK. - Added a getting started guide to help users install, configure, and build their first RAG application. - Documented key functions such as feedDocsToRAG, queryDocsFromRAG, and delete, with usage examples and parameter details. - Included an overview section highlighting the SDK's capabilities and architecture, along with advanced metadata filtering techniques.
- Introduced foundational concepts for using the @microfox/db-upstash SDK, including data modeling and indexing strategies. - Added a getting started guide to help users install, configure, and utilize the SDK effectively. - Documented key classes such as CrudHash, CrudStore, and Paginator, with detailed API references and usage examples. - Included best practices for data management and error handling, enhancing user understanding of the SDK's capabilities.
- Introduced foundational concepts and architecture for using the @microfox/puppeteer-sls SDK, focusing on serverless browser automation. - Added a getting started guide to help users install and run their first automation script. - Documented key functions such as openPage, takeSnapShot, extractLinks, and others, with usage examples and parameter details. - Included best practices for serverless usage and limitations to enhance user understanding of the SDK's capabilities.
…SDKs - Changed the title and description to provide a clearer overview of the Micro SDKs. - Added a welcome section detailing the purpose of the documentation. - Included a new section listing available SDKs with brief descriptions and links for each, enhancing user navigation and understanding of the offerings.
- Reformatted the documentation JSON structure for improved readability and organization. - Added new sections for various Micro SDKs, including AI, Communication, Database, and Research, with detailed groupings and pages for each SDK. - Ensured consistent formatting across all groups and pages to facilitate easier navigation and understanding of the documentation.
…commit options - Added an option to specify a single tracker file for workflow generation using the --file flag. - Implemented error handling for non-existent tracker files. - Enhanced job configuration to include conditional commit steps based on user-defined settings. - Improved workflow generation by adding support for GitHub Actions permissions and commit message customization.
- Introduced a new optional commit configuration within the TrackerConfig interface. - Added properties to enable committing changes, customize commit messages, and specify a personal access token environment variable for pushing changes.
- Introduced a new JSON configuration file for tracking documentation of multiple SDKs, including rag-upstash, brave, db-upstash, puppeteer-sls, slack, and aws-ses. - Each entry includes the SDK name, categories, and auto-update settings to streamline documentation management and updates.
- Added a new tracker script to synchronize documentation for Micro SDKs based on a central configuration file. - Implemented logic to read package configurations, process documentation files, and update the navigation structure in the main docs.json. - Enhanced logging for better visibility during the sync process and error handling for missing project roots and navigation groups.
- Introduced a new workflow to automate the synchronization of Micro SDKs documentation upon pushes to the main branch. - The workflow includes steps for checking out code, setting up Node.js, installing dependencies, running the tracker, and committing changes if any updates are detected.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Quick rundown on the new docs automation.
There's a new
docs-config.jsonfile in thescripts/__track__folder now. It's basically just a list of the SDKs that should be in the docs.If
"auto-update": trueis set for an SDK in that file, its docs are automatically grabbed from the package source and built into the main documentation site.For running things manually, here are the commands:
To sync the docs locally:
To regenerate the CI workflow file: