Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: rockydocs_formatting.md spelling #2582

Merged
merged 1 commit into from
Jan 17, 2025
Merged

fix: rockydocs_formatting.md spelling #2582

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/guides/contribute/rockydocs_formatting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ A document might or might not need to contain any of these elements. However, if
A Link to [that header](#-a-header)
```

This link is found by hovering your mouse over the permalink in a created document, but is essentially the header with the "#" plus the header in lower-case seperated by a dash (-).
This link is found by hovering your mouse over the permalink in a created document, but is essentially the header with the "#" plus the header in lower-case separated by a dash (-).

When the document is translated, though, the header is translated BUT the link is outside of what Crowdin allows to be translated, so it remains in its original (English) state.

If you find yourself in need of using an anchor, take a look at your document and see if reorganization of the content will make that anchor unneccessary. Just know that if you use an anchor in a newly composed document, that anchor will break once translation of that document occurs.
If you find yourself in need of using an anchor, take a look at your document and see if reorganization of the content will make that anchor unnecessary. Just know that if you use an anchor in a newly composed document, that anchor will break once translation of that document occurs.

## Admonitions

Expand Down Expand Up @@ -560,7 +560,7 @@ The last code shows that certain characters require their HTML character code if

In actual text, you would escape the character. For example, `\|` will show the pipe symbol, `\>` will show the angle bracket symbol, `\+` will show the plus sign, `\-` will show the minus sign, and `\!` will show the exclamation mark.

You can see that if we get rid of the back ticks in this sentence:
You can see that if we get rid of the backticks in this sentence:

In actual text, you would escape the character. For example, \| will show the pipe symbol, \> will show the angle bracket symbol, \+ will show the plus sign, \- will show the minus sign, and \! will show the exclamation mark.

Expand Down
Loading