Skip to content

Commit

Permalink
fix the spelling errors and add to dictionary
Browse files Browse the repository at this point in the history
  • Loading branch information
sjspielman committed Mar 12, 2024
1 parent e7fbe8a commit 6951c7f
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 5 deletions.
37 changes: 37 additions & 0 deletions .github/components/dictionary.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,39 @@
ableist
ALSF
Bioinformatics
Carpentries
conda
config
DM
doxxing
formatters
Github
GitKraken
JSON
LGBTQ
LinkedIn
linter
linter's
linters
LSfR
macOS
MacOS
Miniconda
Nonconsensual
OpenScPCA
openscpca
pre
Pre
precommit
README
renv
reproducibility
ScPCA
socio
Stumptown
trainings
transphobic
triaged
WisCon
WSL

1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
# OpenScPCA-analysis

Speeling is aparently a real word.
6 changes: 3 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ To serve the documentation during local development, run `mkdocs serve` from the

Documentation is written as a series of markdown files nested by topic in directories.

- All directories at the top-level inside `docs` will represent navbar sections.
- All directories at the top-level inside `docs` will represent `navbar` sections.
- Each top-level directory should contain an `index.md` file with an overall description of what that section contains.
- The `index.md` should have an L1 header with the same title as the navbar section.
- The `index.md` should have an L1 header with the same title as the `navbar` section.
- Markdown files in each directory represent sections shown along the left sidebar.
- Nested directories within each navbar section should be used to add an additional bold (gray) header on the left sidebar.
- Nested directories within each `navbar` section should be used to add an additional bold (gray) header on the left sidebar.
- Markdown files within each nested directory will fall under this additional bold (gray) header.
- Any visual aids used in the docs should be placed in `docs/img`.

Expand Down
2 changes: 1 addition & 1 deletion docs/technical-setup/install-a-github-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ After installing Git, you will also need take these steps:
- [Set up an SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) to interact with GitHub
- [Set up your Git config file](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup)

### Install Git on MacOS
### Install Git on macOS

We recommend installing Git via Apple's developer command line tools.
For this, launch a Terminal window, enter the command shown below, and follow the instructions.
Expand Down

0 comments on commit 6951c7f

Please sign in to comment.