-
-
Notifications
You must be signed in to change notification settings - Fork 347
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add relative links to various file references (#1392)
## Context <!-- Please include a summary of the change, with motivation and context --> <!-- Bonus: if you are comfortable writing one, please insert a user-story https://en.wikipedia.org/wiki/User_story#Common_templates --> Was just reading through the docs here on GH and saw a lot of references to files that could have relative links to those files for easy click through ## Details <!-- Describe here how you address the issue --> - when a specific file in the codebase was referenced, link to it - did not otherwise change the formatting of the content and left it as-is (e.g. bold text) - also fix a few incorrect (moved?) locations: - `HomeDBManager.ts` now in `homedb/` dir - a few files missing extensions - some incorrect extensions (e.g. was `.ts` but it's actually still `.js`) - having links to the files makes it much easier to find these issues - and standardize one file reference that was different from the rest ("Python sandbox in this code:" -> "Python sandbox in [...]") ## Related issues <!-- If suggesting a new feature or change, please discuss it in an issue first --> <!-- If fixing a bug, there should be an issue describing it with steps to reproduce --> <!-- If this does not solve entirely the issue, make also a checklist of what is done or not: --> Made some other docs improvements in #1391 ## Has this been tested? <!-- Put an `x` in the box that applies: --> - [n/a] 👍 yes, I added tests to the test suite - [n/a] 💭 no, because this PR is a draft and still needs work - [x] 🙅 no, because this is not relevant here - [n/a] 🙋 no, because I need help <!-- Detail how we can help you --> I double-checked all the links to ensure they worked properly. Also my code editor (VS Code) would autocomplete the relative paths correctly when I typed them as another form of check.
- Loading branch information
Showing
4 changed files
with
63 additions
and
65 deletions.
There are no files selected for viewing
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
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
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
Oops, something went wrong.