https://github.com/a-b-street/docs
Technical and user documentation for A/B Street
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.0%) to scientific vocabulary
Repository
Technical and user documentation for A/B Street
Basic Info
- Host: GitHub
- Owner: a-b-street
- License: apache-2.0
- Language: JavaScript
- Default Branch: main
- Size: 265 MB
Statistics
- Stars: 12
- Watchers: 5
- Forks: 7
- Open Issues: 7
- Releases: 0
Metadata Files
README.md
A/B Street docs
This repo contains the source code (in Markdown format) of the technical documentation and user guides for A/B Street. We use mdbook for formatting, and have a Github action publish on every commit. Contributions to the docs, all of which you can find as .md files in the book/src folder of this repo, and which can be edited on GitHub are very welcome!
To build the book, download or clone the repo, e.g. using the gh CLI as follows:
bash
git clone https://github.com/a-b-street/docs
Then you can change directory and start editing the files, e.g. with the following commands:
bash
cd docs
edit book/src/tech/dev/api.md
That should open an editor with the contents of the api.md open, ready for you to edit. You can also edit the files such as the API documentation linked to above directly in GitHub.
The following commands will serve a locally hosted version of the book from the book folder (assuming you have Rust installed):
bash
cargo install mdbook # install the mdbook crate used to serve the book
cd book
mdbook serve # serve book locally to dynamically update to show your changes
After running the commands above you should see a version of the docs at 127.0.0.1:3000/.
To keep the markdown files formatted the prettier npm package is used.
Install it and run the formatting script as follows (on Ubuntu, replace apt with your package manager of choice):
bash
sudo apt install npm
sudo npm install -g prettier
./format_md.sh
After your Pull Request has been accepted you will be able to see the deployed docs at https://a-b-street.github.io/docs.
Owner
- Name: A/B Street
- Login: a-b-street
- Kind: organization
- Email: dabreegster@gmail.com
- Location: Seattle, WA
- Website: abstreet.org
- Twitter: CarlinoDustin
- Repositories: 14
- Profile: https://github.com/a-b-street
Transportation planning and traffic simulation software for creating cities friendlier to walking, biking, and public transit
GitHub Events
Total
- Push event: 5
- Pull request review event: 1
- Pull request event: 2
- Fork event: 1
Last Year
- Push event: 5
- Pull request review event: 1
- Pull request event: 2
- Fork event: 1
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Dustin Carlino | d****r@g****m | 317 |
| Michael Kirk | m****e@e****e | 18 |
| Robin | R****e | 11 |
| Jennifer Ding | j****2@g****m | 2 |
| Transurgeon | p****e@g****m | 2 |
| homersimpsons | g****e@g****m | 1 |
| coleow | 1****w | 1 |
| Stefano Probst | s****9@g****m | 1 |
| Jonas Matthias | 5****s | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: about 1 year ago
All Time
- Total issues: 18
- Total pull requests: 27
- Average time to close issues: about 1 month
- Average time to close pull requests: about 9 hours
- Total issue authors: 7
- Total pull request authors: 9
- Average comments per issue: 3.17
- Average comments per pull request: 2.07
- Merged pull requests: 25
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: 31 minutes
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- dabreegster (8)
- Robinlovelace (5)
- Transurgeon (1)
- tko (1)
- chraibi (1)
- coleow (1)
- Zero3 (1)
Pull Request Authors
- Robinlovelace (9)
- dabreegster (6)
- michaelkirk (4)
- coleow (4)
- homersimpsons (2)
- senden9 (1)
- Transurgeon (1)
- jonasmatthias (1)
- dingaaling (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v2 composite
- actions/setup-node v3 composite
- peaceiris/actions-gh-pages v3 composite
- peaceiris/actions-mdbook v1 composite