docs: cleanup documents #1111
Merged
docs: cleanup documents #1111
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
[air.rs](./air.rs) is invalid. Changed to [air.rs](./src/air.rs)
"[Writing the Guest Program](../../benchmarks/README.md#writing-the-guest-program" is invalid. Changed to "[Writing the Guest Program](../../../benchmarks/README.md#writing-the-guest-program"
"[fibonacci example](./bin/fibonacci.rs)" is not working. Changed to "[fibonacci example](./src/bin/fibonacci.rs)".
"[Overview of Basic Usage](./overview.md)" is invalid. Changed to "[Overview of Basic Usage](../writing-apps/overview.md)".
"[github workflows](./.github/workflows/benchmark-call.yml)" is invalid link. Changed to "[github workflows](../../.github/workflows/benchmark-call.yml)".
- "an memory access" -> "a memory access" The phrase "an memory access" is considered incorrect because the article "an" is used before words that begin with a vowel sound. Since "memory" starts with a consonant sound, the correct article to use is "a," making it "a memory access."
jonathanpwang
approved these changes
Dec 17, 2024
There was a problem hiding this comment.
Thanks!
CI is failing due to a permission issue which should have been fixed in #1112
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.
Summery
Fix typo and invalid links
Description
I'v been checked every ‘md’ files in the repository and found some invalid links and typo.
I fixed most of the invalid links, but #1110 (comment) thought it was better to open an issue rather than fix them arbitrarily.
I also found a minor typo and fixed it, otherwise the documentation looks perfect. Hope this helps.