Skip to content

Commit

Permalink
directory structure updates
Browse files Browse the repository at this point in the history
  • Loading branch information
sjspielman committed Mar 4, 2024
1 parent 59e62dd commit 20ef32f
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Documentation is written as a series of markdown files nested by topic in direct
## Adding new documentation

As outlined in [this IA issue](https://github.com/AlexsLemonade/OpenScPCA-analysis/issues/61), we have several sections of documentation.
The diagram below shows the directory structure for the docs, for now considering only the top three directory levels.
The diagram below shows the directory structure for the docs.
The directory names as written in the IA issue are shown in parentheses.

Each bold bullet point in the IA issue is a directory, and each plain-text bullet is a markdown file.
Expand All @@ -50,15 +50,19 @@ If you are adding new images/visual aids for documentation, place them in the `i
├── technical-setup (Setting up)
│   └── environment-setup (Getting access to resources)
├── communications-tools (Communicating within the Project)
│   ├── github-discussions (Github Discussions)
│   └── github-issues (Github Issues)
│   └── writing-issues (Writing good issues)
├── contributing-to-analyses (Contributing to an analysis)
│   ├── analysis-modules (Analysis modules)
│   ├── doing-analyses (Doing an analysis)
│   │   └── working-with-git (Working with git)
│   ├── planning-analyses (Planning your analysis)
│   └── pull-requests (Creating Pull Requests)
│   ├── pull-requests (Creating Pull Requests)
│ │ └── filing-pull-requests (Filing a PR)
│ │ ├── before-filing (Before filing a PR)
│ │ └── creating-pull-requests (Creating the PR)
│   ├── pr-review-process (PR Review Process)
│ └── merging-prs (Merging a PR)
├── software-platforms (Software tools)
│   ├── aws
│   ├── docker
Expand Down

0 comments on commit 20ef32f

Please sign in to comment.