-
Notifications
You must be signed in to change notification settings - Fork 1.9k
update: update docs for the new WebHelp engine #2393
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
Conversation
3d48b1d
to
5167052
Compare
2) renamed _nav.tree to kc.tree. 3) removed coroutines overview from the list; a title for a hands-on tutorial
…into docs-transfer
2) renamed _nav.tree to kc.tree. 3) removed coroutines overview from the list; a title for a hands-on tutorial
# Conflicts: # docs/basics.md # docs/cancellation-and-timeouts.md # docs/composing-suspending-functions.md # docs/coroutine-context-and-dispatchers.md # docs/exception-handling.md # docs/select-expression.md # docs/shared-mutable-state-and-concurrency.md
update: update knit.properties
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.
Three major points:
-
Please update
CONTRIBUTING.md
so it's clear how to edit the documentation (stardust plugin etc.) and see the result. Currently, it's not clear either to maintainers or external contributors -
We have references to the guide in our main Github page (
README
section) and these guides are now not so readable. I'd suggest replacing links inREADME
from.md
files to the actual website. In addition, it would be nice if each.md
section started with a paragraph like "...this is an internal documentation, please use ${THIS_LINK_TO_THE_WEBSITE_WITH_THIS_SECTION} instead" -
We moved a lot of
.md
files, would be nice to have basic redirect (even if it's a short text "file was moved") for people who have been referencing these docs from their blogposts and code.
@katia-energizer will prepare it soon.
I've updated the README.md with new links. Some files (
I've added stubs for all moved *.md files. |
* update: update cancellation-and-timeouts.md * update: update channels.md * update: update composing-suspending-functions.md * update: update coroutine-context-and-dispatchers.md * update: update coroutines-guide.md * update: update exception-handling.md * update: update select-expression.md * update: update shared-mutable-state-and-concurrency.md * update: update basics.md * update: update flow.md * update: update flow.md * update: update _nav.yml * update: add _nav.tree * update: update links * update: fixes after review * update: get rid of divs * update: add new lines for WebHelp parser * update: add new lines for WebHelp parser * fix: fix knit errors * removed _nav.yml; * renamed _nav.tree to kc.tree. * removed coroutines overview from the list; a title for a hands-on tutorial * update: Made kc.tree as valid XML * update: added a configuration file project.ihp * update: added a configuration file buildprofiles.xml * update: moved coroutines overview from the main repository * update: update cancellation-and-timeouts.md * update: update channels.md * update: update composing-suspending-functions.md * update: update coroutine-context-and-dispatchers.md * update: update coroutines-guide.md * update: update exception-handling.md * update: update select-expression.md * update: update shared-mutable-state-and-concurrency.md * update: update basics.md * update: update flow.md * update: update flow.md * update: update _nav.yml * update: add _nav.tree * update: update links * update: fixes after review * update: get rid of divs * removed _nav.yml; * renamed _nav.tree to kc.tree. * removed coroutines overview from the list; a title for a hands-on tutorial * update: Made kc.tree as valid XML * update: added a configuration file project.ihp * update: added a configuration file buildprofiles.xml * update: moved coroutines overview from the main repository * update: move debug tutorials to coroutines repository * update: update after knit * update: move all docs files to topics/ * update: corrected the xml version of project.ihp * update: move old jvm tutorial coroutines-basic-jvm.md * update: moved knit.properties to resolve relative path correctly * update: add stubs for moved pages * update: update README.md Co-authored-by: Ekaterina.Volodko <[email protected]>
No description provided.