You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,12 @@
4
4
5
5
We use Next.js and Netlify to build our [documentation site](https://docs.streamlit.io/).
6
6
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
+
7
13
## Building
8
14
9
15
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
18
24
19
25
- In your terminal, run the following command:
20
26
```bash
21
-
$ xcode-select --install
27
+
xcode-select --install
22
28
```
23
29
24
30
#### Install `make` on Windows
@@ -63,13 +69,14 @@ This repo follows a typical Next.js project structure. To contribute, you'll onl
63
69
-`scripts/` Contains JS files.
64
70
-`styles/` Contains CSS files for styling and layout.
65
71
66
-
## Contributing
72
+
## Content guide
67
73
68
74
To add, edit, or delete content in our documentation, you have to modify Markdown (`.md`) files within folders and sub-folders in `content/` :
69
75
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.
70
79
-`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.
73
80
-`index.md` Contains text that populates the index page.
74
81
-`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.
0 commit comments