Several minor documentation fixes (Part 2) #6495
Merged
Conversation
This file contains hidden or 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
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.
This PR is a follow-up of #6437 and fixes several minor issues in the documentation of ZIO v2.x. In order to avoid too big PRs, this PR focuses only on the Sections
Data Types / Concurrency / {ZIO Fibers, Concurrency Primitives}. After this PR is merged, I would continue with the next sections in a similar way./next/datatypes/fiber/and/next/datatypes/stm/and/next/datatypes/stream/. To each of these URLs, two different Markdown files were mapped on them, namely, the introduction text (index.md) as well as the respective content file with the same name as its directory (fiber.md,stm.md,stream.md, respectively). This led to the fact that only one of both respective pages, either the introduction or the content page, was publically available, but not both (!), while the navigation bar highlights both of them. These URLs are now de-duplicated for v2.x by explicitly setting the URLs of the content-pages (via docusaurus'slug) toxxx.md, thus, for example,/next/datatypes/fiber/now always serves the introduction, while/next/datatypes/fiber/fiber.mdserves the content-page. By choosing thexxx.mdslug, we don't need to modify any documentation-internal links to this page. Note that this fix brings up now three new pages that were not publically visible before (!)fiberref#inheritrefsclaimed that two specific effects behave identically, which was not true, since theinheritRefsvariant sometimes fails the assertion, since due to race conditions it sometimes merges theFiberRef's value before it is set from 0 to 10 by the child fiber. These examples were modified to point out the main difference betweenjoinandinheritRefs, namely, thatjoinwaits and merges final values, whileinheritRefsmerges current values and continues.As before, please review the details, but also tell me if you disagree with some general attitude of this PR, so that I can adapt to your feedback (e.g. I might be too picky on inserting articles
aandthehere and there).