-
Notifications
You must be signed in to change notification settings - Fork 945
Description
I'm interested in contributing a feature to Docsy, but I'm confused by the various repositories: "Goldydocs" (I'm not sure exactly what that is, but I've seen it referenced in the Docsy docs), this repo (google/docsy), and the Docsy example repo.
I found the contributor's guide in the user docs after a bit of a search. I've raised PR #188 to add a link to the user doc from the contrib guide in the repo, to make it easier to find. I think it'd be good to clarify a few things in the contributor's guide.
I'm keeping a running commentary in this issue, to make it easier to update the contributor's guide at some point. I may find time to do it myself at some point, but if anyone else wants to pick this up, please do!
When adding a feature to Docsy, my main confusion was around these points:
-
Both the docsy repo and the docsy-example contain
config.toml
files. I'd have expected the two config files to be very similar, but the one in the docsy repo is almost empty. I'm guessing therefore that I should put any params needed for my feature into the docsy-example repo only. -
I've figured out that I should add usage instructions to the guide in the docsy repo. It took me a while to figure this out, as I was at first confused by the similar URLs and similar look and feel for the two sets of docs (docsy.dev and example.docsy.dev). I think it'd be good to prompt contributors to add usage docs for their new features or update the existing docs for any changes they make, and to point contributors to the place where they can add the docs.
-
Ah, now I see that example.docsy.dev has the title Goldydocs. I think this is a little confusing and we should change the title to something prosaic but straightforward like "Docsy Example Site". :)
-
Should I add the new partial layout for my feature into both the docsy repo and the docsy-example repo? At first, I assumed I should, because otherwise how can you test it? But then I ran into major problems with updating the Docsy submodule in the Docsy Example repo. Even after I figured out how to commit changes to the submodule (the answer is here) , I ran into build problems on Netlify (local worked fine) and had to revert the changes. So now I'm thinking I should add the new layout just to the docsy repo, not to docsy-example.
-
Should I add the new parameters for my feature into both the docsy repo and the docsy-example repo? At first it seemed like I should add the related params to the docsy-example repo and not to the docsy repo, because the config.toml at the root of the docsy repo has very little in it and points to the docsy-example repo for a list of all params. But later, I'm thinking maybe I should add my params into the config file for the userguide in the docsy repo, as well as in the config file in the docs-example repo.