Propose restructuring the docs to include a short explanation backed by the example of std::ranges::find()#266
Open
Fureeish wants to merge 9 commits intoCpp4You:mainfrom
Open
Conversation
Collaborator
Author
|
Regarding this part:
I'm beginning to question the value of doing that. On one hand it ties the elements together and reduces the workload by quite a bit, but on the other hand docs should be as independent as possible. Awaiting your inputs. |
…nd hide some information in the simplified section
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.
Description
sidebar_labelname.I would also suggest to make families of algorithms refer to each other (since we already split them, e.g., https://en.cppreference.com/w/cpp/algorithm/ranges/find into individual finds). I.e., instead of repeating most of the things in
find,find_if,find_if_not, etc., have one, main section (in this case -find()) and make the rest of them refer (by links and other associations) to it.Type of Change
Changes in docs (
docs)improve(docs)- e.g. added a new paragraph, example, using a better wording, adding a new document, etc.fix(docs)- bug fix, e.g. fix a typo, page render issueBREAKING CHANGE(docs)- e.g. removing a document/article/category that was referenced in many other placesrefactor(docs)- changed a code example, e.g. replaced old code with a modern onechore(docs)- other changes that don't affect the docs, e.g. updating the CI/CD pipelineChanges in the platform (
platform)feat(platform)- a new feature, e.g. a new MDX component, plugin, theme, etc.fix(platform)- bug fix, e.g. fix a typo, issue causing component to crashBREAKING CHANGE(platform)- e.g. removing a feature, changing the API, etc.refactor(platform)- code improvements, changes, e.g. unifying style, renaming internals, etc.docs(platform)- updated code documentationchore(platform)- other changes that don't affect the platform directly, e.g. updating the CI/CD pipeline