diff --git a/README.md b/README.md index 3658a25a..6022faa7 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ## How the Documentation is Organized -Directories that contain only content +Directories that contain information used to build content.
_develop | Information for application miners covers using the Javascript library, our mobile SDKs, and the concepts hat support them. Navigation controlled by developer menu | -This information was never associated with a single repo. Much of it does rely heavily onhttps://github.com/blockstack/blockstack.js. | +This information was never associated with a single repo. Much of it does rely heavily on https://github.com/blockstack/blockstack.js. | +
_faqs | +Contains a JSON source file for all the FAQs. The JSON in this directory | +||
_includes | @@ -48,11 +53,11 @@ Directories that contain only content|||
_org | -Information for Stacks holders and people curious about what Blockstack does. User docs controlled by in the the organization menu | +Information for Stacks holders and people curious about what Blockstack does. Appear in the the organization menu | Not associated with any repository. |
_storage | -+ | Information for developers using storage in their apps or creating Gaia servers. Appear in the the storage menu | https://github.com/blockstack/blockstack-gaia |
File | +Contains | +Purpose | +
---|---|---|
_faqs/allfaqs.json | +Liquid to generate JSON from theFAQS.json | +Serves up the FAQs that are consumed by the blockstack.org and stacks.com sites. | +
_develop/faq-data.json | +Liquid to generate JSON from appFAQ.json. | +Serves up the FAQs that are consumed by the app.co site. NOTE: App.co was never changed to pull from the same file as blockstack.org. |
+
_faqs/allFAQs.md | +Liquid and headings. | +Reads the _data/theFAQs.json and produces a Markdown file for display in our site. | +
_data/theFAQs.json | +JSON for the FAQS. | +Source file for all the FAQs. | +
_data/appFAQ.json | +JSON for the app mining FAQs. | +Source file for the application mining FAQs. | +
_develop/appMiningFAQ.md | +Liquid to extract the app mining FAQs from the allFAQs.json file. | +Display just the app mining FAQs in the docs. | +