docs: add hyperlinks to directories and improve navigation #5178
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
neubig
reviewed
Nov 21, 2024
| When you write code, it is also good to write tests. Please navigate to the `tests` folder to see existing test suites. | ||
| At the moment, we have two kinds of tests: `unit` and `integration`. Please refer to the README for each test suite. These tests also run on GitHub's continuous integration to ensure quality of the project. | ||
| When you write code, it is also good to write tests. Please navigate to the [`./tests`](./tests) folder to see existing test suites. | ||
| At the moment, we have two kinds of tests: [`unit`](./tests/unit) and `integration`. Please refer to the README for each test suite. These tests also run on GitHub's continuous integration to ensure quality of the project. |
There was a problem hiding this comment.
It'd be good to add "integration" too
There was a problem hiding this comment.
Thanks for the suggestion! Would ./tests/runtime be the right link for integration? If not, could you point me in the right direction? Still learning the file structure by going through the docs and code—great project, by the way!
Thanks for the docs philosophy insight! |
Co-authored-by: Graham Neubig <[email protected]>
Co-authored-by: Graham Neubig <[email protected]>
Co-authored-by: Graham Neubig <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
End-user friendly description of the problem this fixes or functionality that this introduces
Give a summary of what the PR does, explaining any non-trivial design decisions
Link of any specific issues this addresses