bee-agent-framework icon indicating copy to clipboard operation
bee-agent-framework copied to clipboard

feat: migrate documentation to mintlify

Open vabarbosa opened this issue 11 months ago • 5 comments

Which issue(s) does this pull-request address?

Closes: #675

Description

this PR migrates the current documentation to Mintlify

  • .md files converted to .mdx updating syntax where necessary
  • links reviewed & updated
  • Python and TypeScript documentation combined
  • Python and TypeScript code blocks moved into a tabbed code preview container
  • update poe docs script accordingly

Checklist

General

Code quality checks

  • [ ] Linting passes: Python poe lint or poe lint --fix / TypeScript yarn lint or yarn lint:fix
  • [ ] Formatting is applied: Python poe format or poe format --fix / TypeScript: yarn format or yarn format:fix
  • [ ] Static type checks pass: Python poe type-check

Testing

  • [ ] Unit tests pass: Python poe test --type unit / TypeScript yarn test:unit
  • [ ] E2E tests pass: Python poe test --type e2e / TypeScript: yarn test:e2e
  • [ ] Integration tests pass: Python poe test --type integration
  • [ ] Tests are included (for bug fixes or new features)

Documentation

  • [ ] Documentation is updated
  • [ ] Embedme embeds code examples in docs. To update after edits, run: Python poe docs --type build

vabarbosa avatar Apr 07 '25 13:04 vabarbosa

#739 #740 #741 #742 are ready to merge into this docs/mintlify branch (before this is merged to main)

planetf1 avatar Apr 09 '25 09:04 planetf1

We could merge this branch (I created a branch off it & rebased cleanly, it also has no broken links). However until this replaces the existing docs there's a risk of content divergence.

planetf1 avatar Apr 14 '25 18:04 planetf1

I fixed the UI and script embedding.

Tomas2D avatar May 13 '25 18:05 Tomas2D

I merged changes from @markstur. Updated the integration guide, some links, and added the embedding section.

Tomas2D avatar May 26 '25 09:05 Tomas2D

I merged changes from @markstur. Updated the integration guide, some links, and added the embedding section.

Looks great! Let's get this on main so we can maintain it with smaller updates.

markstur avatar May 27 '25 15:05 markstur

Weeee! Nice job team 👏

jenna-winkler avatar May 30 '25 15:05 jenna-winkler

🎉 Thanks, Tomas! So good to have this on main instead of a branch

markstur avatar May 30 '25 17:05 markstur