Skip to content

add the beginner contribution tips in readme.md #1417

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

Merged
sfc-gh-dmatthews merged 2 commits into from
Mar 4, 2026
Merged

add the beginner contribution tips in readme.md #1417

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ecdf86
add the biginner contribution tips in readme.md
PriyanshuPrateek Feb 20, 2026
b7cb2c3
Update readme
sfc-gh-dmatthews Mar 4, 2026
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
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

We use Next.js and Netlify to build our [documentation site](https://docs.streamlit.io/).

## Contributing

New contributors can help improve Streamlit documentation by fixing typos, improving clarity, and adding helpful examples. Documentation contributions are a great way to get started with open source.

To contribute to the Streamlit library itself, see the [Streamlit library contributing guide](https://github.com/streamlit/streamlit/blob/develop/CONTRIBUTING.md).

## Building

To build the docs, clone this repo, install the NPM dependencies, and start the development server.
Expand All @@ -18,7 +24,7 @@ Make sure you have [`npm`](https://docs.npmjs.com/downloading-and-installing-nod

- In your terminal, run the following command:
```bash
$ xcode-select --install
xcode-select --install
```

#### Install `make` on Windows
Expand Down Expand Up @@ -63,13 +69,14 @@ This repo follows a typical Next.js project structure. To contribute, you'll onl
- `scripts/` Contains JS files.
- `styles/` Contains CSS files for styling and layout.

## Contributing
## Content guide

To add, edit, or delete content in our documentation, you have to modify Markdown (`.md`) files within folders and sub-folders in `content/` :

- `deploy/` Contains `.md` files that populate the Deploy section.
- `develop/` Contains `.md` files that populate the Develop section, including the API Reference.
- `get-started/` Contains `.md` files that populate the Get Started section.
- `kb/` Contains `.md` files that populate the Knowledge Base.
- `library/` Contains `.md` files that populate the Streamlit Library section.
- `streamlit-cloud/`Contains `.md` files that populate the Streamlit Community Cloud section.
- `index.md` Contains text that populates the index page.
- `menu.md` This is a special file containing only front matter that defines the docs Menu. You will need to add an entry on this file for each new page you create within the docs' site.

Expand Down