Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[GEN-2217]: enhance destinations documentation auto-generation script #2257

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

[GEN-2217]: enhance destinations documentation auto-generation script #2257

wants to merge 20 commits into from
+4,742 −2,542

Conversation

BenElferink
Copy link
Contributor

@BenElferink BenElferink commented Jan 18, 2025 •
edited
Loading

This PR introduces new features to the destinations documentation auto-generation script:

  • Improve Adding Destination to Odigos to include UI section
  • Add auto-generate Configuring Destination Fields section
  • Add mintlify page metadata and create a Getting Started section
  • Add auto-generate for the Supported Backends pages in mint.json
  • Add auto-generate for the whole backends-overview.mdx file
  • Updated "contribute destination" instructions

Example of fully generated overview page:

Screenshot 2025-01-18 at 16 29 50

Example of fully generated destination page (with ZERO manual edits):

Screenshot 2025-01-18 at 16 30 09 Screenshot 2025-01-18 at 16 30 17 Screenshot 2025-01-18 at 16 30 20

@BenElferink BenElferink added the documentation Improvements or additions to documentation label Jan 18, 2025
@notion-workspace Notion Workspace
Copy link

Enhance Python script for destination docs

@BenElferink BenElferink requested a review from blumamir January 18, 2025 09:33
@BenElferink BenElferink mentioned this pull request Jan 18, 2025
Closed
BenElferink
BenElferink commented Jan 18, 2025
View reviewed changes
docs/adding-new-dest.mdx Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blumamir blumamir Awaiting requested review from blumamir

@damemi damemi Awaiting requested review from damemi

@edeNFed edeNFed Awaiting requested review from edeNFed

@RonFed RonFed Awaiting requested review from RonFed

@tamirdavid1 tamirdavid1 Awaiting requested review from tamirdavid1

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@BenElferink