improving docs copy and navigation

[pellicceama]

Important

This PR revamps OpenInt documentation by adding new sections for customization, data flow, embedding, and FAQs, while removing outdated content and updating the navigation structure.

• New Documentation:
  • Adds customize.mdx for styling options of @connect, including themes and color customization.
  • Adds data-flow.mdx to explain OpenInt's connector architecture and data flows.
  • Adds embed.mdx for embedding @connect in web applications, with examples in popular frameworks.
  • Adds faq.mdx for common questions about OpenInt.
• Removed Documentation:
  • Deletes react-embed.mdx, share-magic-links.mdx, web-applications.mdx, data-flow.mdx, and webhooks-events.mdx.
• Navigation Updates:
  • Updates docs.json to reflect new documentation structure, renaming and reorganizing sections under "Getting Started" and "Using @connect".
• Miscellaneous:
  • Adds color-swatch.mdx snippet for color display in documentation.
  • Renames quickstart directory to getting-started and updates file names accordingly.

^{This description was created by for 4358fd1. It will automatically update as commits are pushed.}

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
openint	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	Mar 8, 2025 7:15pm

[ellipsis-dev]

❌ Changes requested. Reviewed everything up to 4358fd1 in 2 minutes and 28 seconds

More details

• Looked at 843 lines of code in 16 files
• Skipped 0 files when reviewing.
• Skipped posting 8 drafted comments based on config settings.

1. docs/connect/customize.mdx:3

• Draft comment:
  Change 'your Own' to 'your own' for consistency.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50%
  None

2. docs/connect/embed.mdx:91

• Draft comment:
  Remove extraneous closing code fence (````) at end of file.
• Reason this comment was not posted:
  Marked as duplicate.

3. docs/getting-started/intro.mdx:26

• Draft comment:
  Typo: 'OpentInt' should be 'OpenInt'.
• Reason this comment was not posted:
  Marked as duplicate.

4. docs/docs.json:21

• Draft comment:
  Inconsistent version labeling: 'v0 (current)' is paired with label 'Version 1'. Clarify version numbers to avoid confusion.
• Reason this comment was not posted:
  Comment was not on a location in the diff, so it can't be submitted as a review comment.

5. docs/connect/customize.mdx:3

• Draft comment:
  Typographical issue: In the description front matter on line 3, consider changing 'your Own' to 'your own' for consistency.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
  This comment is purely informative and does not provide any actionable feedback related to the code functionality or logic. It focuses on a typographical issue in the description, which is not relevant to the code review process.

6. docs/connect/embed.mdx:12

• Draft comment:
  Consider changing 'customer Token' to 'customer token' for consistency and to avoid misleading capitalization.
• Reason this comment was not posted:
  Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50%
  While technically correct about the inconsistency, this is a very minor documentation issue. The meaning is perfectly clear either way. The rules state not to make comments that are obvious or unimportant. This seems like an unnecessarily pedantic comment that doesn't materially improve the documentation.
  The inconsistent capitalization could potentially confuse readers about whether "Token" is a specific type or concept. Technical documentation often benefits from consistent terminology.
  While consistency is good, this is such a minor issue that it doesn't warrant a PR comment. The meaning is clear regardless of capitalization, and this feels like unnecessary noise in the review process.
  Delete this comment as it violates the rule about not making obvious or unimportant comments. The capitalization difference doesn't impact understanding.

7. docs/connect/embed.mdx:91

• Draft comment:
  It appears that line 91 uses four backticks (````) to close the code block. Typically, three backticks (```) are used. Please adjust to maintain consistency.
• Reason this comment was not posted:
  Marked as duplicate.

8. docs/getting-started/intro.mdx:26

• Draft comment:
  Typo found: 'OpentInt' should be corrected to 'OpenInt' for consistency.
• Reason this comment was not posted:
  Marked as duplicate.

Workflow ID: wflow_FV2LPkpIyG9b7qS5

---

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[ellipsis-dev]

Extra backtick in closing code block marker; likely meant to use three backticks (```), not four.

Suggested change

````

[ellipsis-dev]

Typo: 'OpentInt' may be intended as 'OpenInt'.

Suggested change

	It all starts with OpentInt @Connect: a fully featured embeddable integrations portal. It can be shared as a link with your customers or embedded straight into your app.
	It all starts with OpenInt @Connect: a fully featured embeddable integrations portal. It can be shared as a link with your customers or embedded straight into your app.

[ellipsis-dev]

Typographical error: In the phrase get a fresh access tokens, either remove a or change tokens to token to maintain grammatical correctness.

Suggested change

	@Connect communicates directly with OpenInt who then ensures that by the time that you need to perform any operation on an external API you can get a fresh access tokens.
	@Connect communicates directly with OpenInt who then ensures that by the time that you need to perform any operation on an external API you can get a fresh access token.