Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

Update Nitro docs #128

Merged
merged 2 commits into from
Nov 20, 2023
Merged

Update Nitro docs #128

merged 2 commits into from
Nov 20, 2023

Conversation

@hahuyhoang411
Copy link
Contributor

@hahuyhoang411 hahuyhoang411 commented Nov 13, 2023 •
edited
Loading

  • Update Community docs
  • Update API
  • Update Examples (Gradio UI)
  • ... more

@hahuyhoang411 hahuyhoang411 self-assigned this Nov 13, 2023
@dan-menlo
Copy link
Contributor

dan-menlo commented Nov 13, 2023 •
edited by hahuyhoang411
Loading

@hahuyhoang Quick feedback on the WIP Nitro Docs:

URL Structure

Documentation Structure

  • I would recommend a clearer structure for Docs
- Overview (docs root, i.e.http://nitro.jan.ai/docs)
   - What is Nitro?
   - Features
   - Acknowledgements
- Architecture (1 page)
    - Architecture
    - Key Concepts
- Getting Started (1 page)
   - Installation
   - ? (npm, pip etc)
   - Your first Inference Request
- Using Nitro
   - Using Zephyr with Nitro
- Examples
    - Gradio app with Nitro

API Reference

  • Should Nitro have an OpenAPI Swagger defintion? (i.e. curl requests)
/chat_completion
/embeddings

# What other methods will we be supporting?

Branding

  • Icon for site should show Nitro lightning (vs. Jan)
    image

  • Nitro logo seems pretty big (let's please just use a simple emoji⚡)
    image

@hahuyhoang411 hahuyhoang411 added the type: docs Improvements or additions to documentation label Nov 15, 2023
@hahuyhoang411 hahuyhoang411 added this to the Nitro v0.2.0 milestone Nov 15, 2023
@hahuyhoang411
Copy link
Contributor Author

hahuyhoang411 commented Nov 15, 2023

Crystallized the documentation for now. Please pull and comment on the latest one.

@hahuyhoang411
Copy link
Contributor Author

hahuyhoang411 commented Nov 16, 2023

Updated the API Reference for Nitro

@hahuyhoang411
Copy link
Contributor Author

hahuyhoang411 commented Nov 17, 2023

Please look through and merge it for a website launch.

tikikun
tikikun approved these changes Nov 20, 2023
View reviewed changes
Copy link
Contributor

@tikikun tikikun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved, no code changes detected

@tikikun tikikun merged commit a5860b7 into main Nov 20, 2023
@hiro-v hiro-v deleted the update-nitro-docs branch November 20, 2023 03:52
@hiro-v hiro-v self-requested a review November 20, 2023 03:52
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@freelerobot freelerobot Awaiting requested review from freelerobot

@dan-menlo dan-menlo Awaiting requested review from dan-menlo

@hiro-v hiro-v Awaiting requested review from hiro-v

1 more reviewer

@tikikun tikikun tikikun approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@hahuyhoang411 hahuyhoang411

Labels

type: docs Improvements or additions to documentation

Projects

No open projects
Menlo
Archived in project

Milestone

Nitro v0.2.0

Development

Successfully merging this pull request may close these issues.

5 participants

@hahuyhoang411 @dan-menlo @tikikun @hiro-v