Skip to content

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

Merged
merged 58 commits into from
Jan 22, 2021
Merged

Conversation

koshachy
Copy link
Contributor

No description provided.

@koshachy koshachy requested a review from qwwdfsad November 16, 2020 16:10
@koshachy koshachy changed the base branch from master to develop December 22, 2020 18:12
@koshachy koshachy marked this pull request as ready for review January 15, 2021 13:47
Copy link
Collaborator

@qwwdfsad qwwdfsad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Three major points:

  1. 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

  2. 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 in README 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"

  3. 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.

@koshachy
Copy link
Contributor Author

Three major points:

  1. 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

@katia-energizer will prepare it soon.

  1. 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 in README 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"

I've updated the README.md with new links. Some files (debugging.md and compatibility.md) are not published on our website, so I didn't change their links. These files are in old MD format, so there are no issues to render them with standard GH renderer.

  1. 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.

I've added stubs for all moved *.md files.

@qwwdfsad qwwdfsad self-requested a review January 21, 2021 16:38
@qwwdfsad qwwdfsad merged commit dcb51f9 into develop Jan 22, 2021
@qwwdfsad qwwdfsad deleted the docs-transfer branch January 22, 2021 10:07
qwwdfsad pushed a commit that referenced this pull request Feb 15, 2021
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants