Conda-forge.github.io: Meta Docs!

Created on 4 Oct 2019  路  6Comments  路  Source: conda-forge/conda-forge.github.io

It would be nice to add some docs to the Readme and/or docs about how to edit the docs. This can be particularly confusing, since we have multiple dirs which have docs, but only one dir that will actually impact the docs, src.

xref: https://github.com/conda-forge/conda-forge.github.io/issues/884 and a whole bunch of my doc PRs 馃悜

Complexity - low Docs help wanted

All 6 comments

Maybe a contribution guide and PR checklist would be good

Should we switch to using the gh-pages branch for hosting the published website? That would reduce the confusion.

My mistake, gh-pages does not work for user/website pages.

Is that possible on the webpage repo? Thought we were limited to master

@jakirkham, you're right. I fixed my comment.

No worries. Agree that would be easier if possible 馃檪

I guess, this has been fixed.
PR Checklist has been created.
Also, the 'improving the documentation' section (https://conda-forge.org/docs/user/contributing.html#improve-the-documentation) mentions the following:

The source text is stored there in the src/ subdirectory and is formatted using Python鈥檚 reStructuredText system.

Perhaps, to clarify further, after '..stored in the src/ subdirectory' we can add 'and NOT in the /docs subdirectory'.

@jakirkham
@CJ-Wright

Was this page helpful?
0 / 5 - 0 ratings

Related issues

croth1 picture croth1  路  5Comments

jakirkham picture jakirkham  路  3Comments

jakirkham picture jakirkham  路  5Comments

basnijholt picture basnijholt  路  4Comments

jakirkham picture jakirkham  路  6Comments