codewars / docs

The Codewars Docs :construction: WIP
https://docs.codewars.com
MIT License
57 stars 202 forks source link

Update TODO placeholders with actual links: Getting started #84

Open hobovsky opened 4 years ago

hobovsky commented 4 years ago

"Getting started" docs contain links to other areas of docs, which are not available yet. Currently these links are just placeholders marked with TODO, and they need to be filled in when a linked document becomes available.

Occurrences, dumped from VSCode "Find" window:

I:\prv\CodeWars\repos\docs\content\getting-started\community.md
  20,34: See this [detailed documentation (TODO: direct link to Labels reference? same link than the one at the end of the "Communication" part)]() about the different kinds of labels and their use.
  22,46: Discourse posts support [Markdown formatting (TODO: link to Markdown reference)](), so you can use some styling, or present your code neatly with [code formatting blocks (TODO: direct link to chapter on code blocks in Markdown docs)]().
  22,171: Discourse posts support [Markdown formatting (TODO: link to Markdown reference)](), so you can use some styling, or present your code neatly with [code formatting blocks (TODO: direct link to chapter on code blocks in Markdown docs)]().
  30,135: There's a set of rules you should follow to keep interaction with other users a good experience for both sides. You can find them in _(TODO: where? Code of Conduct, some discourse guidelines?)_.
  38,9: - [Chat (TODO: link when ready)]() on Zulip,
  39,19: - Codewars [forum (TODO: link to Discourse forum)]()

I:\prv\CodeWars\repos\docs\content\getting-started\finding-kata.md
  31,64: Details of kata search page are described in [UI documentation (TODO: insert link to documentation of kata search panel)](), but here are some useful hints for beginners:

I:\prv\CodeWars\repos\docs\content\getting-started\kata-solved.md
  21,59: More information on ranks and progress can be found [here (TODO: add link to docs on progress)]().
  25,160: Honor points are rewarded by contributing to Codewars in many ways, and solving a kata is one of them. By earning Honor points you gain additional [privileges (TODO: link to docs)]() and climb [leaderboards (TODO: link to docs)]().
  25,208: Honor points are rewarded by contributing to Codewars in many ways, and solving a kata is one of them. By earning Honor points you gain additional [privileges (TODO: link to docs)]() and climb [leaderboards (TODO: link to docs)]().

I:\prv\CodeWars\repos\docs\content\getting-started\setting-up.md
  17,52: You can find all options described in detail [here (TODO: insert link to actual documentation of UI)](), and below are listed ones useful to get you running as soon as possible:
  22,137: - **Clan** - fill this in if you'd like to team up with your friends, group, or organization. More on Codewars clans can be found [here (TODO: link to clans doc)]()
  28,96: - **Default Catalog List View** - default setting for **"Status"** filter on kata [search page (TODO: link to docs on kata search page)](). Beginners are advised to set it to **"Approved Only"**, but if you want to participate in [beta evaluation process (TODO: link to docs on beta process)](), you can set it to any value you like.
  28,256: - **Default Catalog List View** - default setting for **"Status"** filter on kata [search page (TODO: link to docs on kata search page)](). Beginners are advised to set it to **"Approved Only"**, but if you want to participate in [beta evaluation process (TODO: link to docs on beta process)](), you can set it to any value you like.
  39,63: Again, detailed description can be found in [UI documentation (TODO: insert link to actual documentation of UI)](), but things needed to get you started are briefly explaned below:

I:\prv\CodeWars\repos\docs\content\getting-started\solving-kata.md
  9,69: After opening a kata page, you are presented with the [kata details (TODO: link to kata details panel doc)]() view with general information about it. Read carefully through the description, and if you are ready to face the challenge, you can start your training by clicking on `TRAIN`.
  22,282: t-driven_development) approach. This means that you are encouraged to write not only code for your solution, but also add as many tests in `Sample Tests` panel as you can think of (see [Writing Tests (TODO: add link to explanation how to add more sample tests)]() to see how), for various scenarios, inputs, and edge cases. Most kata will have provided you some sample tests to get you going, while others will not, in which case some test documentation will be shown instead.
  39,287: empt, kata might appear broken, or you receive some errors you do not understand and you have no idea what's going on. Don't worry, there are many ways to get help. See [Troubleshooting your Solution (TODO: add link to FAQ)]() FAQ to get some advice.
Blind4Basics commented 4 years ago

should we make this thread more general and keep track here of all the links to update in the pages we create? (at the beginning, it's of no use, but once we begin to actually do it, keeping track of the files already done or not might help a lot, imo)

hobovsky commented 4 years ago

I created this thread with intention of tracking only this particular section of docs, so I could assign it to me and keep an eye on it. I thought that being more granular will help, and we can use lables to organize many similar threads

Blind4Basics commented 4 years ago

ok