conda-forge.github.io icon indicating copy to clipboard operation
conda-forge.github.io copied to clipboard

Restructuring the user documentation

Open ForgottenProgramme opened this issue 3 years ago • 8 comments

I am proposing certain changes in the ordering and structuring of the sections within the 'user documentation' to give it a better 'flow of information' and continuity.

Please see this google doc.

Proposed changes:

  • [X] Reorder the subsections within the user docs, to have the most important subsections on top. (completed in #1455 )
  • [ ] Take the 'what is conda-forge' section out of 'a brief intro' and put it at the beginning of the documentation. (see why here)
  • [ ] Split 'why conda-forge' into 'what does conda-forge offer' and 'brief history'. (see why here)
  • [x] Add 'can I contribute packages to conda-forge?' section. (see why here) (completed in #1455)

ForgottenProgramme avatar Jun 11 '21 11:06 ForgottenProgramme

@conda-forge/core

viniciusdc avatar Jun 11 '21 17:06 viniciusdc

@ForgottenProgramme I think we should create a checklist with some of the additions we want to do (as well addressing the respective PR's to it once created). That way we can explain a little bit more about the goals for those changes.

viniciusdc avatar Jun 16 '21 14:06 viniciusdc

@ForgottenProgramme I think we should create a checklist with some of the additions we want to do (as well addressing the respective PR's to it once created). That way we can explain a little bit more about the goals for those changes.

Noted. Will do.

ForgottenProgramme avatar Jun 16 '21 14:06 ForgottenProgramme

Hi, can I work on this?

shloka-gupta avatar Mar 25 '22 18:03 shloka-gupta

Hi can I work on this?

@beckermr @kathatherine

vanshmehra avatar Apr 08 '22 10:04 vanshmehra

@vanshmehra @chicken-biryani You are both welcome to work on this. Sorry I missed your question before, @chicken-biryani. We're not assigning issues, so feel free to get started and make a PR. @chicken-biryani, I believe you've been making small issues related to this?

kathatherine avatar Apr 11 '22 21:04 kathatherine

@kathatherine Kinda! I believe they align with the aim of this issue.

I did create a similar issue on restructuring the docs completely. But I think I spoke too soon. :')

Also, while we're on the subject of restructuring... Do you think we'll ever switch to RTD (Read the docs) instead?

shloka-gupta avatar Apr 11 '22 21:04 shloka-gupta

@chicken-biryani There are no plans to switch to RTD that I know of, but we can definitely keep it in mind.

kathatherine avatar Apr 12 '22 14:04 kathatherine