On code & documentation page, explain more about where to find the docs

[brittag]

Currently https://eregs.github.io/technology/ explains where to find the various parts of eRegulations and what they do. We have a bunch of other documentation that's a little bit hard to find from that page - you have to poke around a bit to find it. For example: some of the repository readmes have extensive explanations in themselves, and some of the readmes also lead to additional resources.

For example:

• https://github.com/18F/regulations-parser links to https://regulation-parser.readthedocs.org/en/latest/
• https://github.com/18F/regulations-core links to http://regulations-core.readthedocs.org/en/latest/
• https://github.com/18F/regulations-site links to https://github.com/18F/regulations-site/blob/master/README_BACKBONE.md

Let's make this /technology/ page better communicate where to find explanations.

[TheLastQuestion]

On https://eregs.github.io/story/ there is a "How it works" section. The first phrase, "Code and documentation" seems to want to link to https://eregs.github.io/story/technology/ which apparently doesn't exist.

[cmc333333]

@TheLastQuestion thanks for the catch. We meant to link to https://eregs.github.io/technology/

[nicoleslaw]

@cmc333333 Given the number of repos listed here and the current implementation on this page pulling them in, do you think it would be helpful to make it easier to find the docs in the repos themselves over adding the doc links to eregs.github.io?

[cmc333333]

I'd be in favor of that plan if the repos weren't so interconnected -- right now, agencies can't really get up and running without looking at several different sets of documentation. I think the ideal here would be to remove the docs from the individual repos and instead consolidate them in one place. Since that's not on the super-close horizon, how do you think we should proceed?

[nicoleslaw]

Hmm, agreed. I think it's worth making the repos more uniform so devs can find the documentation in the same place for each of them over adding somewhat duplicative links here... but I am open to us holding on this issue if it's not the best time to try to address this.