Skip to content
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

Docs: Improved Structure for "adding packages" to help contributors find information #13673

Closed
7 of 10 tasks
prince-chrismc opened this issue Oct 21, 2022 · 0 comments · Fixed by #15004
Closed
7 of 10 tasks
Assignees
Labels

Comments

@prince-chrismc
Copy link
Contributor

prince-chrismc commented Oct 21, 2022

This has been a long standing short coming that make it difficult for new contributors to learn some of the finer details and costs time on the reviewers to help pull requests get merged - and less important but notably the build resources are not insignificant when dozens of commits are pushed trying to correct issues.

🔎 Preview of the direction: https://github.com/conan-io/conan-center-index/compare/master...prince-chrismc:conan-center-index:docs/seperate-by-method?expand=1

Proposed Structures

Break down content by

break down methods into their own files (there will be some grouping based on size like "configure, config_options, and validate" would be an example)

Possible Future Work

Notable changes

  • FAQs and Error Knowledge will point to the new folder and serve to direct people to the "how" answer... the why might stay (TBD how it unfolds)
  • everything about "code in the recipes/ should be in this new section

Similar efforts

The main Conan docs have gotten the same treatment

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant