Skip to content

Task - Create documentation pages#55

Closed
JuliaGalhardi wants to merge 30 commits intodevfrom
task/docs
Closed

Task - Create documentation pages#55
JuliaGalhardi wants to merge 30 commits intodevfrom
task/docs

Conversation

@JuliaGalhardi
Copy link
Copy Markdown
Contributor

Closes #19

This PR introduces a complete documentation section for the Knowly platform, including new pages, sidebar navigation, and improved user guidance for key features. The documentation is now accessible via the DocsPageWithSidebar routes and covers project motivation, foundation models, integration, knowledge base management, playground testing, and subscription management.

Main changes

  • Docs Sidebar Navigation:
    Added a sidebar navigation for documentation pages, making it easy to switch between topics such as Project Overview, Foundation Models, Integration, Playground, Knowledge Bases, and Subscription Management.

  • Sidebar Improvements:
    Altered the sidebar shared component to be reusable for different features. For it to work, each feature with pages that have a sidebar navegation (user-area and docs) now have a /components directory with the page with sidebar adjusted to their specific pages.

  • New Documentation Pages:

    • About Project: Explains the motivation behind Knowly in a clear, commercial, and less formal language.
    • Foundation Models: Simple explanations of the main foundation models available on AWS and their use cases.
    • Integration: Step-by-step guide on how to integrate with a knowledge base using the API, including a sample request.
    • Knowledge Bases: Instructions on how to create, edit, and delete knowledge bases through the user profile settings.
    • Playground Testing: Explains how users can test their knowledge bases in a chat-like interface before integrating with other systems.
    • Subscription Management: Guides users on how to manage and change their subscription plans from the user area.
  • Consistent Typography:
    Created and applied reusable typography components (h1, h2, p, ul, li, etc.) for all documentation pages, ensuring a consistent and accessible look.

  • Background and Layout Improvements:
    Ensured that the background color and blobs extend correctly on scroll for all documentation pages, matching the behavior of the home and FAQ pages.

  • Routing:
    Updated app-routes.tsx to include all new documentation routes under the DocsPageWithSidebar element, using the new sidebar layout. Also added link/route to docs in the navbar.

Motivation

These changes aim to provide a clear, user-friendly, and visually consistent documentation experience for Knowly users, making it easier for them to understand, test, and manage the platform's features.


Note:
All documentation content was written in a simple, direct, and commercial tone. More details can be added with the development of the project.

@JuliaGalhardi JuliaGalhardi added this to the Documentação milestone Aug 17, 2025
@JuliaGalhardi JuliaGalhardi self-assigned this Aug 17, 2025
@JuliaGalhardi JuliaGalhardi added documentation Improvements or additions to documentation ui Tasks related to interface design or visual elements of the application refactoring Code improvements without changing external behavior labels Aug 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation refactoring Code improvements without changing external behavior ui Tasks related to interface design or visual elements of the application

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Escrita das documentações

2 participants