Closed JeremyMcCormick closed 5 months ago
Maybe it would useful for the users to know a bit about the repository structure, and especially in which directory are the files to change or add (i.e.
content/
). I don't think we should invite them to change anything inlayout/
for instance.
Agreed - I'll try to add some additional text indicating where the content pages should go.
I skimmed through the text.
I think that it is fine, at least for now.
Maybe a little too much for an entry user, but on Wdnesday we will have feedback on that.
I agree that it could be overwhelming for an entry level user. I am thinking that the sections on Git and Github could be streamlined by pointing to some existing external documentation, e.g., the parts on how to make a PR and the git add/commit/push
workflow.
It's also possible that the local hugo
section can essentially be marked as optional. With the versioned sites working now, it would be possible to just check changes there in the contributor's branch site under /v
rather than needing to do it locally.
This is the initial version of documentation for contributors.