Skip to content

Commit 9d07a8e

Browse files
add the beginner contribution tips in readme.md (#1417)
* add the biginner contribution tips in readme.md * Update readme --------- Co-authored-by: Debbie Matthews <debbie.matthews@snowflake.com>
1 parent d0ef3bd commit 9d07a8e

1 file changed

Lines changed: 11 additions & 4 deletions

File tree

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

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

7+
## Contributing
8+
9+
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.
10+
11+
To contribute to the Streamlit library itself, see the [Streamlit library contributing guide](https://github.com/streamlit/streamlit/blob/develop/CONTRIBUTING.md).
12+
713
## Building
814

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

1925
- In your terminal, run the following command:
2026
```bash
21-
$ xcode-select --install
27+
xcode-select --install
2228
```
2329

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

66-
## Contributing
72+
## Content guide
6773

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

76+
- `deploy/` Contains `.md` files that populate the Deploy section.
77+
- `develop/` Contains `.md` files that populate the Develop section, including the API Reference.
78+
- `get-started/` Contains `.md` files that populate the Get Started section.
7079
- `kb/` Contains `.md` files that populate the Knowledge Base.
71-
- `library/` Contains `.md` files that populate the Streamlit Library section.
72-
- `streamlit-cloud/`Contains `.md` files that populate the Streamlit Community Cloud section.
7380
- `index.md` Contains text that populates the index page.
7481
- `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.
7582

0 commit comments

Comments
 (0)