-
Notifications
You must be signed in to change notification settings - Fork 6.2k
docs: create link.md #3903
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.
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
docs: create link.md #3903
Conversation
docs/link.md
Outdated
@jawnsy
jawnsy
Aug 5, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since this is a top-level page, this should be a h1 heading
also, since it's a new page, we need to add it to the docs manifest or else it won't be navigable
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this @ashumz 🙌
So like Jonathan said, we'll need to add to do a couple of things:
- add to
/docs/manifest.json - format using
yarn fmtlocally - clean up commits (mind squashing into one commit?)
I think that should be it! Let us know how we can help too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TIL about shell-session 🤯
https://github.com/github/linguist/blob/master/lib/linguist/languages.yml#L5594-L5605
I'd appreciate help with those things @jsjoeio. Not really sure how the manifest.json file works and don't have a ton of time to spend trying to figure it out if it's easy for someone else to push to the finish line. 🙏
Id appreciate help with those things @jsjoeio . Not really sure how the manifest.json file works and don't have a ton of time to spend trying to figure it out if it's easy for someone else to push to the finish line. 🙏
I'm on it!
link to --link docs from README to separate docs entry
751e911 to
8c70dfa
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made changes, looks good now!
Codecov Report
Merging #3903 (1ff9d30) into main (7338037) will not change coverage.
The diff coverage isn/a.
❗ Current head 1ff9d30 differs from pull request most recent head 8c70dfa. Consider uploading reports for the commit 8c70dfa to get more accurate results
Impacted file tree graph
@@ Coverage Diff @@ ## main #3903 +/- ## ======================================= Coverage 63.51% 63.51% ======================================= Files 36 36 Lines 1872 1872 Branches 379 379 ======================================= Hits 1189 1189 Misses 580 580 Partials 103 103
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing data
Powered by Codecov. Last update 7338037...8c70dfa. Read the comment docs.
Hey @jsjoeio - much appreciation for taking this under your wing. Unfortunately the destination link is 404'ing for me - https://coder.com/docs/code-server/v3.11.0/link
Not sure how the manifest file works, but could it be from the -- characters in the title? 🤷♀️ Thanks for your help!
@ashumz - thanks for pointing that out and sorry you caught that before we did! I think it was a misunderstanding on our side with how the docs are generated. We'll work with @BrunoQuaresma to get it fixed!
link to --link docs from README to separate docs entry