docs: quickstart and homepage improvements #2008

cahyosubroto · 2024-02-13T07:19:57Z

Describe Your Changes

In this pull request, I focused on enhancing the overall user experience and accessibility of the documentation website. Here are the key changes:

Added Quickstart Documentation:
- Included detailed Quickstart documentation to help users get started quickly.
- Modified the configuration file to ensure the Quickstart menu appears in the Navbar, improving navigation.
Revamped Homepage Design:
- Introduced a new design for the homepage to enhance visual appeal and user engagement.

Fixes Issues

None

Self Checklist

[] Added relevant comments, especially in complex areas.
Updated documentation to reflect the changes made.
Created issues for follow-up changes or refactoring needed.

Additional Notes:
Include any additional information that might be helpful for reviewers, such as specific challenges faced, notable decisions made, or any dependencies introduced.

cc: @aindrajaya

Sync dev branch to docs branch

Update the docs by adding examples of the latest documentation by Pena

Update the configuration file which shows the Quickstart menu in the Navbar

freelerobot · 2024-02-13T08:30:12Z

@hiento09 for when you're back. Is there a way to enable autodeploy to github pages, with our ci, so we can preview the docs contributions?

freelerobot

Thank you - left a few change requests

Suggestion: it's probably easier to work on smaller PRs, in order to get unblocked and generally move faster

freelerobot · 2024-02-14T07:35:26Z

docs/docs/quickstart/changelog/0.2.0.mdx

+
+## Changes
+
+ - feat: Add Jan Hacker House event page to Docs


I like including the changlog in our docs - it highlights how fast our codebase moves.

However, manually copying this info is redundant, since we can just point users to the github release pages.

Is there a way to automate this, or just do a simple link-out.

I think we could implement GitHub API to fetch the data from the GitHub Releases page and programmatically input it into Jan AI docs.

freelerobot · 2024-02-14T07:36:06Z

docs/docs/quickstart/install.mdx

+
+:::
+
+        ### Stable Releases


formatting, indentation seems off?

Will double check it.

freelerobot · 2024-02-14T07:37:13Z

docs/docs/quickstart/models-list.mdx

+sidebar_position: 3
+---
+
+# Supported Models


We support all GGUF models and more. I like that this page helps with SEO, by including a lot of model names, but I don't want users to get the wrong idea that these are the only models we support. Is there a way to convey both

freelerobot · 2024-02-14T07:37:41Z

docs/docs/quickstart/quickstart.mdx

+    </TabItem>
+</Tabs>
+
+2. After you run Jan, the program will take you to the Chatting window, with list of threads and each thread is a chatting box between you and the AI model.


Threads, not "chatting"

Ok I will update it.

freelerobot · 2024-02-14T07:38:04Z

docs/docs/quickstart/quickstart.mdx

+
+To learn more about system requirements for your operating system, go to [Installation guide](/docs/install).
+
+### Step 2: Select AI Model


This page is helpful. Thanks for including it.

freelerobot · 2024-02-14T07:38:32Z

docs/src/components/HomepagePrimaryFeatures/index.js

+                <div className={clsx(styles.cards)}>
+                    <div className={clsx(styles.card, styles.cardBluish)}>
+                        <div>
+                            <p>Lorem ipsum dolor</p>


placeholder text intentional?

Yes it is intentional. Will update it once we have the full doc complete

freelerobot · 2024-02-14T07:38:45Z

docs/src/components/HomepageSecondaryFeatures/index.js

+                                <img alt={"Feature logo"} src={"/img/homepage-new/bg-rocket.png"}/>
+                            </div>
+                            <div className={styles.cardContent}>
+                                <h3>Praesent vel Felis Vehicula</h3>


placeholder text intentional?

Yes it is intentional. Will update it once we have the full doc complete

freelerobot · 2024-02-14T07:39:10Z

docs/static/img/homepage-new/docusaurus-social-card.jpg

why do we need this?

Sorry, will remove.

freelerobot · 2024-02-14T07:39:43Z

docs/static/img/homepage-new/undraw_docusaurus_mountain.svg

seems like we're reincluding a lot of docusaurus default assets with this PR. why do we need these again?

Sorry, we forgot to remove them. Will remove it

freelerobot

Hey guys, not sure why I was re-requested to review this as there are unresolved comments.

Let's split this PR into smaller ones? Thank you!

Content updated for models, integration and extensions section

0xHieu01 · 2024-02-22T07:08:32Z

Hi @cahyosubroto @aindrajaya, as a new update, we recently merge the new structure of main page to dev branch. #1941 with preview available at https://dev.jan.ai/. Thus, some of content in this PR is currently outdated when you open PR from your folk branch to docs branch. (docs branch is branch of main website jan.ai is only syncing with dev after release or urgent content update). Could you point this branch to dev branch after re-update the outdated content with new structure?

Because this PR is created from the folk repo (not have an access to Cloudflare API key deployment), when you open the PR, it won't create the preview demo. There are 2 solutions.

If you are already add to the repo, please create a new branch from current dev branch, then open the pull request. As team, it will auto generate preview demo with Cloudflare api key
Otherwise, I just created docs-pena-team may be create a pull request from your folk to docs-pena-team with update version of outdated content. Then, I can merge to docs-pena-team and create PR from docs-pena-team to dev for generate preview for easily reviewing.

cc: @0xSage @dan-jan

aindrajaya · 2024-02-22T12:32:31Z

Thanks, @hieu-jan, for the prompt update and for notifying us about the recent merge of the new main page structure into the dev branch. I will thoroughly review the PR and make the necessary adjustments to ensure that the content aligns seamlessly with the new structure from the dev branch.
The second option is great; I will create a pull request from my fork to "docs-pena-team" with the updated version of the outdated content.

cc: @cahyosubroto

0xHieu01 and others added 5 commits February 7, 2024 11:03

Merge pull request menloresearch#1948 from janhq/dev

3060679

Sync dev branch to docs branch

Docs update - Quickstart

12060f3

Update the docs by adding examples of the latest documentation by Pena

Add assets for Quickstart and Homepage

de828f0

Update Docusaurus Configuration

6b9fc55

Update the configuration file which shows the Quickstart menu in the Navbar

Update homepage UI

35c1a07

aindrajaya added the type: docs Improvements or additions to documentation label Feb 13, 2024

freelerobot requested review from freelerobot, dan-menlo, 0xHieu01 and urmauur and removed request for dan-menlo and 0xHieu01 February 13, 2024 08:28

freelerobot changed the title ~~Docs~~ docs: quickstart and homepage improvements Feb 13, 2024

freelerobot assigned cahyosubroto Feb 13, 2024

freelerobot requested changes Feb 14, 2024

View reviewed changes

aindrajaya requested review from freelerobot and dan-menlo February 15, 2024 01:13

freelerobot requested changes Feb 15, 2024

View reviewed changes

aindrajaya added 3 commits February 19, 2024 09:51

Delete static changelog

d751a4a

Update latest comment feedback

735b455

Update the content

6bf3efa

Content updated for models, integration and extensions section

0xHieu01 changed the base branch from docs to docs-pena-team February 22, 2024 06:56

0xHieu01 changed the base branch from docs-pena-team to dev February 22, 2024 06:56

0xHieu01 changed the base branch from dev to docs February 22, 2024 06:57

0xHieu01 changed the base branch from docs to docs-pena-team February 22, 2024 07:08

aindrajaya closed this Feb 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: quickstart and homepage improvements #2008

docs: quickstart and homepage improvements #2008

cahyosubroto commented Feb 13, 2024 •

edited by aindrajaya

Loading

freelerobot commented Feb 13, 2024

freelerobot left a comment

freelerobot Feb 14, 2024

aindrajaya Feb 15, 2024

freelerobot Feb 14, 2024

aindrajaya Feb 15, 2024

freelerobot Feb 14, 2024

freelerobot Feb 14, 2024

aindrajaya Feb 15, 2024

freelerobot Feb 14, 2024

freelerobot Feb 14, 2024

cahyosubroto Feb 19, 2024

freelerobot Feb 14, 2024

cahyosubroto Feb 19, 2024

freelerobot Feb 14, 2024

cahyosubroto Feb 19, 2024

freelerobot Feb 14, 2024

cahyosubroto Feb 19, 2024

freelerobot left a comment

0xHieu01 commented Feb 22, 2024

aindrajaya commented Feb 22, 2024 •

edited

Loading


		To learn more about system requirements for your operating system, go to [Installation guide](/docs/install).

		### Step 2: Select AI Model

docs: quickstart and homepage improvements #2008

docs: quickstart and homepage improvements #2008

Conversation

cahyosubroto commented Feb 13, 2024 • edited by aindrajaya Loading

Describe Your Changes

Fixes Issues

Self Checklist

freelerobot commented Feb 13, 2024

freelerobot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freelerobot left a comment

Choose a reason for hiding this comment

0xHieu01 commented Feb 22, 2024

aindrajaya commented Feb 22, 2024 • edited Loading

cahyosubroto commented Feb 13, 2024 •

edited by aindrajaya

Loading

aindrajaya commented Feb 22, 2024 •

edited

Loading