Skip to content

Commit e454b11

Browse files
author
Liz
committed
Clean up README, add links to contributing guide and license file.
1 parent 4612817 commit e454b11

File tree

1 file changed

+6
-31
lines changed

1 file changed

+6
-31
lines changed

README.md

Lines changed: 6 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,12 @@
1-
# Algorand Documentation Website
1+
# Algorand Developer Documentation (Official)
22

3-
## Setup
4-
5-
- `pip install -r requirements.txt`
3+
This is the official repository for the [Algorand Developer Documentation](https://developer.algorand.org/docs/) hosted on the [Algorand Developer Portal](https://developer.algorand.org/).
64

75
## Contributing
8-
For more information about how to contribute documentation see the mkdocs documentation:
9-
http://www.mkdocs.org/user-guide/writing-your-docs/
10-
11-
#### Navigation Bar
12-
Because we have so many generated documents, we aren't able to use the default mkdocs.yml navigation bar, instead we're using [MkDocs Awesome Pages Plugin](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin).
13-
14-
This allows you to do a few things, but the most important thing to know is how to set the order of pages in the navigation bar. Each docs directory may contain an optional **.pages** file, for example [here is the one in the root directory](docs/.pages). You can specify directories or markdownfiles. If the navigation bar should have a different title than the directory, the **.pages** file can also include a title, [as shown here](docs/Reference-Docs/teal/.pages).
15-
16-
## Testing
17-
18-
```
19-
mkdocs serve
20-
```
21-
22-
## Deploying
23-
24-
```
25-
mkdocs gh-deploy
26-
```
27-
28-
## Generated Docs
29-
30-
There are some tools to help with this in the **scripts** directory.
6+
Learn how you can contribute in our [Guide to Contributing](./CONTRIBUTING.md).
317

32-
- goal (go cli, spf/cobra)
33-
- algokey (go cli, spf/cobra)
34-
- kmd (swagger, ???)
35-
- algod (swagger, ???)
8+
## License
369

10+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
3711

12+
The documentation is licensed under an MIT license. See [LICENSE file](./LICENSE.md) for details.

0 commit comments

Comments
 (0)