Task - Create documentation pages#55
Closed
JuliaGalhardi wants to merge 30 commits intodevfrom
Closed
Conversation
d07282d to
9e060a0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
DocsPageWithSidebarroutes 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
/componentsdirectory with the page with sidebar adjusted to their specific pages.New Documentation Pages:
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.tsxto include all new documentation routes under theDocsPageWithSidebarelement, 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.