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.

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

new docs front page #1426

Open
3 tasks
mashby2022 opened this issue Apr 4, 2024 · 1 comment
Open
3 tasks

new docs front page #1426

mashby2022 opened this issue Apr 4, 2024 · 1 comment
Assignees
Labels
documentation Documetation is missing or incorrect enhancement New feature or request needs-triage Relates to issues that should be refined ux UX design required, requested or worked on
Milestone

Comments

@mashby2022
Copy link

mashby2022 commented Apr 4, 2024

Overview

We need to make changes to Botkube's docs front page to be more user-friendly and introduce a new section about AI assistant. Notion page.
Format should be similar to https://docs.testkube.io/
Specifically:
De-emphasize open-source focus: Revise the installation page to downplay open-source aspects and make cloud the default installation.
Add AI section: Create a dedicated AI section on the usage page(how it is pre-installed, how to disable it, generic image of what is/architecture, how to get started with 3-5 examples commands)

Acceptance Criteria

  • Introduce "Home" Page, Dashboard which navigate user to the most important parts of the docs. This page also should bold the main features of Botkube.
  • Update Installation Documentation: The revised installation page should reduce its emphasis on being open-source.
  • Create AI Section in Usage Documentation: The usage page should include a new AI section with the elements described above.

Reason

Improved User Experience (Installation)
Enhanced Understanding of AI Assistant

@mashby2022 mashby2022 added enhancement New feature or request documentation Documetation is missing or incorrect labels Apr 4, 2024
@mashby2022 mashby2022 added this to the v1.10.0 milestone Apr 4, 2024
@pkosiec pkosiec modified the milestones: v1.10.0, v1.11.0 Apr 5, 2024
@pkosiec pkosiec added the needs-triage Relates to issues that should be refined label Apr 5, 2024
@pkosiec pkosiec modified the milestones: v1.11.0, v1.12.0 May 14, 2024
@pkosiec pkosiec modified the milestones: v1.12.0, v1.14.0 Jun 18, 2024
@madebyrogal
Copy link
Contributor

@miklosp we need your input here. Designs of the home page at least

@madebyrogal madebyrogal modified the milestones: v1.14.0, v1.13.0 Jun 18, 2024
@pkosiec pkosiec added the ux UX design required, requested or worked on label Jun 18, 2024
@pkosiec pkosiec modified the milestones: v1.13.0, v1.14.0 Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documetation is missing or incorrect enhancement New feature or request needs-triage Relates to issues that should be refined ux UX design required, requested or worked on
Projects
Status: Todo
Development

No branches or pull requests

5 participants