Conversation
Summary of ChangesHello @jenna-winkler, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request undertakes a significant cleanup and reorganization of the project's documentation. The primary goal is to enhance the clarity, consistency, and discoverability of information by consolidating related guides under new, more logical directory structures. This includes updating all internal links and navigation configurations, introducing a new guide for CLI server authentication, and refining existing CLI command documentation, while also removing obsolete content to streamline the overall documentation experience. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request refactors and cleans up the documentation by reorganizing files into guides and sdk directories, removing obsolete pages, and adding a new guide for connecting the CLI to a remote server. The changes improve the structure and clarity of the documentation. I've found a broken link in the navigation configuration and suggested a few minor improvements for consistency and better user experience in the new documentation file.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com>
Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com>
Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com>
56bf56f to
d0ef606
Compare
* docs: updates Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> * Update docs/docs.json Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> * Update authenticate-cli-to-server.mdx Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> * Update README.md Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> * docs: updates --------- Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com>
…1513) * Add blog post: How to Run a BeeAI Framework Agent as an A2A Server Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * Finalize A2A Server blog post after preview edits Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * Update a2a-server.mdx Updated based on gemini feedback Signed-off-by: Eden Gilbert <117227212+edengilbert@users.noreply.github.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(ui): group trajectories (#1482) Signed-off-by: Petr Kadlec <petr@puradesign.cz> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(ui): proactive access_token refresh to avoid refresh race (#1501) Signed-off-by: Petr Kadlec <petr@puradesign.cz> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(ui): runtime envs and feature flags cleanup (#1479) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(ui): render mermaid diagrams and latex syntax in markdown (#1488) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(sdk): utilize platform auth in mcp extension (#1508) Signed-off-by: Tomas Pilar <thomas7pilar@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(server): add user info endpoint (#1505) Signed-off-by: Radek Ježek <radek.jezek@ibm.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * docs: remove redundant ToC from connectors guide (#1519) Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(ui): array length checks (#1526) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat: initial implementation for connectors management in UI (#1443) * feat: initial implementation for connectors management in UI Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * feat: connectors prep work Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * feat: proper error handling Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * fix: missing licence headers Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * fix: imports Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * fix: missing schema Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * chore: post rebase adjustments Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * fix: proper schema Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * fix: code review comments Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> --------- Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * docs: update deployment guide (#1525) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(ui): make 'add new agent' button admin only (#1527) Signed-off-by: Petr Kadlec <petr@puradesign.cz> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * docs: overhaul (#1540) Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(docs): add guide on connecting CLI to remote servers (#1541) Signed-off-by: Tomas Pilar <thomas7pilar@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(server): refresh unmanaged agent cards (#1528) Signed-off-by: Aleš Kalfas <kalfas.ales@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * docs: minor changes (#1545) Signed-off-by: Matous Havlena <havlenma@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore: docs workflow (#1502) * chore: docs workflow Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * fix: better quoting Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * fix: better git habndling Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * chore: improve PR template Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * chore: provide docs Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> --------- Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore: bump up uvicorn timeouts to 5s, make configurable (#1548) Signed-off-by: Matous Havlena <havlenma@gmail.com> Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Co-authored-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(server): connectors header forwading (#1553) Signed-off-by: Tomas Pilar <thomas7pilar@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * release: v0.4.2-rc1 Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * docs: add explicit WSL instructions Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix: long operations inside transactions cause db connection exhaustion (#1549) Signed-off-by: Radek Ježek <radek.jezek@ibm.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * ci: add missing mise.lock checksums Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(agentstack-cli): clarify agent statuses (fixes #1535) Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(agentstack-cli): redesign agentstack list output Fixes #1536 Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * docs(agentstack-cli): add custom help text (#1554) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * docs: improve WSL2 installation instructions Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * Update deployment-guide.mdx (#1573) Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore: fixing dead links in the docs (#1557) Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * refactor(web): use single framewok-diagram.svg file themeable with CSS variables (#1539) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * refactor(ui): rework Spinner component with CSS only animation, remove lottie-react (#1538) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(agentstack-cli): properly react to misconfigured WSL2 Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * docs(agentstack-cli): clarify WSL install steps Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(agentstack-cli): add `agentstack server switch` alias Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(ui): remove links to docs and support (#1570) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore(ui): update "starting the agent" copy (#1571) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(ui): messages being cut off on narrower screens (#1546) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(ui): hide offline agents (#1434) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(ui): render Markdown syntax inside trajectories (#1555) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore(server): add resource discovery root fallback to connectors (#1587) Signed-off-by: Tomas Pilar <thomas7pilar@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(ui): update homepage and sidebar (#1512) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore: remove unnecessary __init__.py (#1494) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(ui): replace trajectory group with latest content, add docs (#1523) Signed-off-by: Petr Kadlec <petr@puradesign.cz> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(ui): mute error toasts on session expiration (#1589) Signed-off-by: Petr Kadlec <petr@puradesign.cz> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix: avoid setting up embeddings on RITS resolves #1578 Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat: update beeai-framework Signed-off-by: Tomas Dvorak <toomas2d@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * Update README.md (#1569) * Update README.md Add Radek's agent as reference Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> * Update README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> * Update README.md * Update README.md * Update README.md Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> --------- Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * docs: cleanup (#1586) * docs: updates Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> * Update docs/docs.json Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> * Update authenticate-cli-to-server.mdx Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> * Update README.md Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> * docs: updates --------- Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(helm): peroperly configure agent_registry.sync_period_cron Fixes #1211 Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(tests): skip heavy docling e2e test (#1595) Signed-off-by: Radek Ježek <radek.jezek@ibm.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat: add validation for agent import URL (#1544) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(agentstack-cli): use better heuristics for determining for adding agents (#1603) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(agentstack-cli): add server info and confirmations to CLI commands (#1590) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(cli): add SingleSelect field support to forms (#1596) Signed-off-by: Petr Kadlec <petr@puradesign.cz> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(ui): display agent-generated images in response markdown (#1601) Signed-off-by: Petr Kadlec <petr@puradesign.cz> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(ui): render markdown in API error messages (#1593) Signed-off-by: Petr Kadlec <petr@puradesign.cz> Signed-off-by: Petr Bulánek <bulanek.petr@gmail.com> Co-authored-by: Petr Bulánek <bulanek.petr@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * docs: add permissions and tokens page (#1576) Signed-off-by: Radek Ježek <radek.jezek@ibm.com> Signed-off-by: Matous Havlena <havlenma@gmail.com> Co-authored-by: Matous Havlena <havlenma@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(server): send proxy errors as a2a errors (#1594) Signed-off-by: Radek Ježek <radek.jezek@ibm.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(tests): use maximize disk space action (#1607) Signed-off-by: Radek Ježek <radek.jezek@ibm.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(tests): switch to custom model again (#1608) Signed-off-by: Radek Ježek <radek.jezek@ibm.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore: form extension rework (#1481) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(server): include redirect_uri into connector's token request (#1616) Signed-off-by: Tomas Pilar <thomas7pilar@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat: update beeai framework (#1611) Signed-off-by: Tomas Dvorak <toomas2d@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(cli): agent info command missing auth (#1622) Signed-off-by: Radek Ježek <radek.jezek@ibm.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat(ui): redo sidebar and homepage (#1610) Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * feat: extending TS sdk (#1609) * feat: extending TS sdk Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * fix: code review comments Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * fix: remove GET from the callApi function, still keep the method for extensibility in the future Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * chore: cleanup package.json Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * chore: testing release pipeline Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * chore: install mise Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * fix: no git checks Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * chore: setup release action Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> * fix: code review commnets Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> --------- Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * release: v0.4.2-rc2 Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * fix(agents): add temporary fallback imports (#1624) Signed-off-by: Radek Ježek <radek.jezek@ibm.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * release: v0.4.2-rc3 Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore: update release sdk to npm instead of pnpm Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * release: v0.4.2-rc4 Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore: update npm for release Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * release: v0.4.2-rc5 Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore: add release tag for npm Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * release: v0.4.2-rc6 Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore: missing repository Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * release: v0.4.2-rc7 Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> * chore: run mise fix Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> --------- Signed-off-by: Eden Gilbert <eden.gilbert@ibm.com> Signed-off-by: Eden Gilbert <117227212+edengilbert@users.noreply.github.com> Signed-off-by: Petr Kadlec <petr@puradesign.cz> Signed-off-by: Tomas Pilar <thomas7pilar@gmail.com> Signed-off-by: Radek Ježek <radek.jezek@ibm.com> Signed-off-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com> Signed-off-by: Aleš Kalfas <kalfas.ales@gmail.com> Signed-off-by: Matous Havlena <havlenma@gmail.com> Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com> Signed-off-by: Tomas Dvorak <toomas2d@gmail.com> Signed-off-by: Petr Bulánek <bulanek.petr@gmail.com> Co-authored-by: Petr Kadlec <petr@puradesign.cz> Co-authored-by: Petr Bulánek <bulanek.petr@gmail.com> Co-authored-by: Tomas Pilar <thomas7pilar@gmail.com> Co-authored-by: Radek Ježek <radek.jezek@ibm.com> Co-authored-by: Jenna Winkler <135358348+jenna-winkler@users.noreply.github.com> Co-authored-by: Tomáš Weiss <tomas.weiss2@gmail.com> Co-authored-by: Aleš Kalfas <32630459+aleskalfas@users.noreply.github.com> Co-authored-by: Matous Havlena <havlenma@gmail.com> Co-authored-by: Jan Pokorný <JenomPokorny@gmail.com> Co-authored-by: Arun Babu Neelicattu <arun.neelicattu@gmail.com> Co-authored-by: Tomas Dvorak <toomas2d@gmail.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Summary
Linked Issues
Documentation
If this PR adds new feature or changes existing. Make sure documentation is adjusted accordingly. If the docs is not needed, please explain why.