Skip to content

chore: update docs_src readme, gitignore. #1146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

chore: update docs_src readme, gitignore. #1146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29837c4
chore: update docs_src readme, gitignore.
k4976 Mar 17, 2025
24f0752
Merge branch 'sparckles:main' into main
k4976 Apr 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,6 @@ docs_src/.vercel

# generated files
docs_src/public/rss/

# env files
*.env
4 changes: 2 additions & 2 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "robyn"
version = "0.65.0"
version = "0.66.0"
authors = ["Sanskar Jethi <[email protected]>"]
edition = "2021"
description = "Robyn is a Super Fast Async Python Web Framework with a Rust runtime."
Expand Down
23 changes: 17 additions & 6 deletions docs_src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
## Docs Base
# Docs Base

This is the documentation website that will be used as a base for Robyn and Starfyre docs.

## Setup
## Environment Variables

To set the enviroment variables, you have to create a .env file in docs_src folder.

Here are some environment variables, you can set :

1. Clone this repo
2. Run `npm install`
3. Run `npm run dev`
4. Open `http://localhost:3000` in your browser
- To provide search functionality by algolia (optional).
- NEXT_PUBLIC_ALGOLIA_APP_ID
- NEXT_PUBLIC_ALGOLIA_API_KEY
- NEXT_PUBLIC_ALGOLIA_INDEX_NAME

## Setup

1. Clone [this repo](https://github.com/sparckles/Robyn)
2. Run `cd Robyn\docs_src`
3. Run `npm install`
4. Run `npm run dev`
5. Open [`http://localhost:3000`](http://localhost:3000) in your browser
Loading