QualiSystems / QualiSystems/cloudshell-help
Reminder to check curly brackets as plain text
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 4
- Forks
- 1
- Avg merge
- 22h 23m
- Merged PRs (30d)
- 7
Description
In some articles, I've noticed we will use "{}" as plain text to explain certain things.
Problem:
When the page loads, there are no errors so it seems like it would be fine. In actuality, the page will show "" as the curly brackets will be missing on the page view
Solution:
For only plain text, and not in between `` or ```code, we need to add a \ before every { or } for them to appear on the view page. example "{}" will appear as "{}"
I'm thinking we can do some searching for {, and } and make sure we didn't miss any by mistake. So far I think I have got them all for the ones I'm doing.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the article sources for literal curly brackets and inspect the rendered page view to confirm how they appear. Escape brackets used as plain text, while leaving content inside inline and fenced code unchanged; done means the affected articles display every intended curly bracket correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100