Add new docs blog #233
Merged
Add new docs blog #233
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
added 2 commits
October 11, 2023 15:57
TGlide
suggested changes
Oct 11, 2023
|
|
||
| "Why don’t they read the docs?" We wanted to find out. | ||
|
|
||
| ## Identifying the issues |
There was a problem hiding this comment.
We should only use # or ### to follow design. DW, we add a level to all headings to ensure no one uses a H1, since we auto-add it on the title. Meaning:
# -> <h2 />## -> <h3 />### -> <h4 />
...
Use # for headlines and ### for sub-headlines.
|
|
||
| The new docs are written using an extended flavor of markdown made with [Markdoc and Svelte](https://github.com/TorstenDittmann/svelte-markdoc-preprocess), which makes community contributions easier. Markdown is easy to read and we can extend it with custom syntax like this multi-code selector. | ||
|
|
||
| `````` |
There was a problem hiding this comment.
Why the ticks before the multicode?
There was a problem hiding this comment.
Why the ticks before the multicode?
It shows the syntax, we don't actually want a multicore to be displayed.
There was a problem hiding this comment.
meant to show syntax
TGlide
approved these changes
Oct 11, 2023
This was referenced Nov 1, 2023
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.
What does this PR do?
Adds a new blog post about our new documentation!
Test Plan
Manual review.