Skip to content

Conversation

Fureeish
Copy link
Collaborator

Description

  • Introduced a short explanation written in human-friendly language at the very top of the docs.
  • Removed whitespace in parentheses from the sidebar_label name.
  • Split one, big, chunky examples snippet into multiple smaller ones with occasional explanations regarding gotchas.
  • Replaced horizontal adjacent view of code and output with vertical one (enhances the readability of examples by allowing more than 50 characters per line without the need for horizontal scrolling).

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 issue
  • BREAKING CHANGE(docs) - e.g. removing a document/article/category that was referenced in many other places
  • 🧹 refactor(docs) - changed a code example, e.g. replaced old code with a modern one
  • 🗑️ chore(docs) - other changes that don't affect the docs, e.g. updating the CI/CD pipeline

Changes 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 crash
  • BREAKING 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 documentation
  • 🗑️ chore(platform) - other changes that don't affect the platform directly, e.g. updating the CI/CD pipeline

@Fureeish Fureeish requested a review from PoetaKodu March 30, 2025 19:29
@Fureeish
Copy link
Collaborator Author

Regarding this part:

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.

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.

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.

1 participant