Skip to content

Commit

Permalink
Flatten contributing book
Browse files Browse the repository at this point in the history
  • Loading branch information
bitzoic committed Apr 3, 2024
1 parent 351fb2b commit 91f0133
Show file tree
Hide file tree
Showing 23 changed files with 29 additions and 29 deletions.
44 changes: 22 additions & 22 deletions docs/contributing-book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Summary

- [Welcome](./documentation/welcome.md)
- [GitHub Issues](./documentation/issues/index.md)
- [Searching for Issues](./documentation/issues/search/index.md)
- [Filtering by label](./documentation/issues/search/filtering.md)
- [Checking for available issues](./documentation/issues/search/assignment.md)
- [Issue summary](./documentation/issues/search/summary.md)
- [Creating an Issue](./documentation/issues/create-issue.md)
- [Library Quality](./documentation/library-quality/index.md)
- [Library Structure](./documentation/library-quality/library-structure.md)
- [Code Structure](./documentation/library-quality/code-structure.md)
- [Documentation](./documentation/library-quality/documentation/index.md)
- [Read me](./documentation/library-quality/documentation/read-me.md)
- [Code](./documentation/library-quality/documentation/code/index.md)
- [ABI Documentation](./documentation/library-quality/documentation/code/abi.md)
- [Comments](./documentation/library-quality/documentation/code/comments.md)
- [Naming Components](./documentation/library-quality/documentation/code/naming-components.md)
- [Style Guide](./documentation/library-quality/documentation/code/style.md)
- [Specification](./documentation/library-quality/documentation/specification.md)
- [Testing](./documentation/library-quality/testing.md)
- [Pull Requests](./documentation/pull-requests/index.md)
- [Committing your work](./documentation/pull-requests/commit.md)
- [Creating a Pull Request](./documentation/pull-requests/creating-pr.md)
- [Welcome](./welcome.md)
- [GitHub Issues](./issues/index.md)
- [Searching for Issues](./issues/search.md.md)
- [Filtering by label](./issues/filtering.md)
- [Checking for available issues](./issues/assignment.md)
- [Issue summary](./issues/summary.md)
- [Creating an Issue](./issues/create-issue.md)
- [Library Quality](./library-quality/index.md)
- [Library Structure](./library-quality/library-structure.md)
- [Code Structure](./library-quality/code-structure.md)
- [Documentation](./library-quality/documentation.md)
- [Read me](./library-quality/read-me.md)
- [Code](./library-quality/code.md)
- [ABI Documentation](./library-quality/abi.md)
- [Comments](./library-quality/comments.md)
- [Naming Components](./library-quality/naming-components.md)
- [Style Guide](./library-quality/style.md)
- [Specification](./library-quality/specification.md)
- [Testing](./library-quality/testing.md)
- [Pull Requests](./pull-requests/index.md)
- [Committing your work](./pull-requests/commit.md)
- [Creating a Pull Request](./pull-requests/creating-pr.md)
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ It's important to check if anyone else is currently working on an particular iss

You can check whether someone is assigned to an issue by looking under the `Assignee` tab. If there is an icon, then someone is tasked with that issue. If there is no icon, then it's likely that no one is currently working on that issue and you're free to assign it to yourself or post a comment so that the author can assign you.

![Filtering issues by an app label image](../../../images/app-filter-assignee.png)
![Filtering issues by an app label image](../images/app-filter-assignee.png)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We encourage the use of the provided templates because they guide a user into an

<br>

![Using issue templates image](../../images/issue-templates.png)
![Using issue templates image](../images/issue-templates.png)

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ The default issues tab shows all of the issues that are currently open. GitHub a

Under the `Label` tab you can select any number of labels and any issue that matches those labels will be shown while the other issues will be hidden.

![Filter by label image](../../../images/filter-dropdown.png)
![Filter by label image](../images/filter-dropdown.png)

<br>

After clicking on the `Lib: Cryptography` label the issues have been filtered to show only the issues that have `Lib: Cryptography` added to them.

Notice that `Lib: Cryptography` is not the only label in the image below. If you wish to further reduce the number of presented issues then additional labels can be added in the same way.

![Filtering issues by an app label image](../../../images/app-filter.png)
![Filtering issues by an app label image](../images/app-filter.png)
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

You can see the activity of an issue by looking at the number of comments. This doesn't really tell you much aside from that there is a discussion about what should be done.

![Filtering issues by an app label image](../../../images/app-filter-comments.png)
![Filtering issues by an app label image](../images/app-filter-comments.pngs)

Clicking on the issue near the bottom `Sum Merkle Proof Verification` we can see some information about the library with some information on what the library intends to implement and why it is needed.

![Filtering issues by an app label image](../../../images/app-documentation.png)
![Filtering issues by an app label image](../images/app-documentation.png)
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In the following sections we will take a look at how to document the:

- [Read me](read-me.md)
- The first document a user will see which includes content such as installation instructions
- [Code](./code/index.md)
- [Code](./code.md)
- Documenting the code itself such that contributors know how to interact with it
- [Specification](specification.md)
- Presenting technical (or non-technical) information about your project

0 comments on commit 91f0133

Please sign in to comment.