jan icon indicating copy to clipboard operation
jan copied to clipboard

docs: Jan's New Documentation Site

Open ramonpzg opened this issue 6 months ago • 3 comments

Jan's New Documentation Site

The new docs for Jan include:

  • Simpler architecture
  • Versioning of different releases
  • Chat with Docs functionality
  • Feedback buttons on pages
  • Detailed tutorial pages with progress tracking

ramonpzg avatar Jun 16 '25 01:06 ramonpzg

Can I help with this somehow?

blueheron786 avatar Jun 17 '25 18:06 blueheron786

need to fix links in readme.md, for example, there is a link to https://jan.ai/docs/installation that goes 404

yesits-me avatar Jun 17 '25 23:06 yesits-me

need to fix links in readme.md, for example, there is a link to https://jan.ai/docs/installation that goes 404

hi @JoaozinhoBrasil I just updated the README.md - fix broken url https://github.com/menloresearch/jan/pull/5357

thank you

@ramonpzg @blueheron786 wants to help 🤝

david-menloai avatar Jun 18 '25 16:06 david-menloai

Upcoming changes to Jan documentation include;

Short Term (v0.6.5)

Jan Server

  • becomes its own tab alongside information about Jan Desktop, Jan Mobile and API Platform
  • Integrations section moves here
  • Tutorials
    • Power X app with Jan
    • Structured Outputs

Image

General Improvements

  • Start Chatting and Quickstart sections get merged
  • Jan Data Folder moves to Reference
  • Jan's product description gets refined
  • Refine Jan Models' sections with more examples

Tutorials to add

  • Day-to-day use cases
    • How to write emails with Jan
    • Mix and Max models for best output, for example, search for content with Jan Nano and then switch to a SOTA model for more comprehensive responses
    • Create meal plans
    • Create workout routines and add items to a todo list app (via MCP)

MCP How To's

  • Search with Exa
  • Search with Serper
  • Search with Perplexity
  • Browser Use
  • File System
  • others...

Model Providers

  • Include
    • fireworks
    • together AI
    • manual setup with modal

Blog

  • Jan's Roadmap
  • Cross blog post in collaborating with .txt

Medium Term (v0.6.7 - v0.7.0)

  • Jan docs move to Astro's. Landing page, blog and changelog stay in Nextra until new website assets are ready
  • API documentation for the server gets revamped
  • Chat with Docs functionality
  • Video tutorials

Long Term (v0.7.0 - v0.8.0)

  • Full migration to Jan's new website
  • Versioned docs for matching release + stub on URL
  • Feedback on doc pages 👍 or 👎
  • Internationalization starting with Spanish, Chinese, and Turkish (languages we speak at Menlo 😃 )
  • Add MCP catalogue for "Servers we like at Menlo"

Long Long Term

  • "Learn AI with 👋 Jan" OR "👋 Jan AI University" (short lessons teaching people about AI, prompting, and so on)
  • Interactive Quickstart/onboarding section by embedding a light version of Jan Web or even a figma mockup

ramonpzg avatar Jul 02 '25 09:07 ramonpzg

29 July 2025

Astro Setup

Ramon

  • [ ] Migrate Current Homepage to https://v2.jan.ai
  • [ ] Move Docs https://v2.jan.ai/docs + let Emre evaluate SEO URLs redirects
  • [ ] Scaffold Handbook
    • Goal: Community feels that can get involved in Jan
    • Model Team
    • Yuuki -> Team Practices

Faisal's help

  • @LazyYuuki to find time on Faisal's schedule
  • [ ] Migrate Changelog
  • [ ] Migrate Blog
  • [ ] Migrate Wall of Love

Product Section

  • Jan's goal is to build a superintelligence that you can self-host and use locally on your own devices
    • We know it's hard
    • We believe that over the next 10 years this is possible
  • Superintelligence is a combination of:
    • Models
    • Tools
    • Application
    • We build a solution that ties all of these seamlessly, so the average consumer is able to use Jan in the same way that he/she does ChatGPT or Claude.
  • I don't think we should call = Jan Factory/Agent

One thing that is missing is the diagram of the Jan "Ecosystem", which shows the different pieces working together:

  • Jan Server
  • Jan Desktop
  • Jan Mobile

Take inspiration from Bitwarden, etc

Application

  • Local Mode, Cloud Mode
  • Change User (i.e. Personal, Work)

Models

  • Overview: Jan is an family of Agentic models
    • We need open source Agentic models - most Agents are thin wrappers on Claude
    • Jan models are trained in Public -> Handbook
  • Versions
    • v1 focuses on Search -> using Jan's Browser Extension

dan-menlo avatar Jul 29 '25 01:07 dan-menlo

new docs is out!!!

LazyYuuki avatar Aug 29 '25 03:08 LazyYuuki