# Rebuilding our Project Documentation

**URL:** <https://forum.openreferral.org/t/rebuilding-our-project-documentation/259>\
**Category:** Governance\
**Created:** [October 10, 2022, 1:43pm UTC](https://forum.openreferral.org/t/rebuilding-our-project-documentation/259 "2022-10-10T13:43:54Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![bloom](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.openreferral.org/bloom/32/103_2.png) [@bloom](https://forum.openreferral.org/u/bloom)\
**Post date:** [October 10, 2022, 1:43pm UTC](https://forum.openreferral.org/t/rebuilding-our-project-documentation/259/1 "2022-10-10T13:43:54Z")

</div>

We’ve long had project docs in [a Google Drive folder](https://drive.google.com/drive/u/0/folders/0B-5CZ4ZLjTHqfk12WTFUbVk1NjBYMjRaZTlZRlN1UjhWMS1MN0tLV3Q4ejY3TWpOYWwwVDg?resourcekey=0-V8QRlJu4Jlrw40yN1U_TKQ), whereas our product docs (HSDS etc) have been in Github and on the ReadtheDocs site.

I’ve taken a go at consolidating them into one set of documentation, all available on the ReadtheDocs site. See [here](https://docs.openreferral.org/en/add-project-docs/initiative/).

Assuming folks think this is good, we’ll use the Drive more for misc file storage, and our primary governance policies will live in markdown files hosted on Github and displayed at [docs.openreferral.org](https://docs.openreferral.org/).

Let me know if you have any questions or suggestions!

---

<div class="post-metadata">

**Author:** ![mroswell](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.openreferral.org/mroswell/32/68_2.png) [@mroswell](https://forum.openreferral.org/u/mroswell)\
**Post date:** [October 14, 2022, 11:48pm UTC](https://forum.openreferral.org/t/rebuilding-our-project-documentation/259/2 "2022-10-14T23:48:01Z")

</div>

Looks good to me! Is there a particular branch where we should issue pull requests? (Master, or something else?) (My speciality is typo fixes: (“conjuction” → “conjunction”)

- [Human Service Data API Suite (HSDA) — Open Referral Data Specifications 2.0.1 documentation](https://docs.openreferral.org/en/add-project-docs/hsda/)
- [specification/index.md at master · openreferral/specification · GitHub](https://github.com/openreferral/specification/blob/master/docs/hsda/index.md)

(Added note: consider renaming Master to Main:

> **[How to rename the "master" branch to "main" in Git](https://www.git-tower.com/learn/git/faq/git-rename-master-to-main)**
>
> Today, many teams want to move away from 'master' as the name of their default Git branch. Find out how to rename your repository's default branch name in a quick and safe manner.

)

---

<div class="post-metadata">

**Author:** ![mroswell](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.openreferral.org/mroswell/32/68_2.png) [@mroswell](https://forum.openreferral.org/u/mroswell)\
**Post date:** [October 15, 2022, 12:03am UTC](https://forum.openreferral.org/t/rebuilding-our-project-documentation/259/3 "2022-10-15T00:03:59Z")

</div>

One more bit of feedback. Any chance of editing the menu colors? The FAQ level questions for instance:  
[Frequently Asked Questions — Open Referral Data Specifications 2.0.1 documentation](https://docs.openreferral.org/en/add-project-docs/faq/)  
are failing the checker for color contrast accessibility.  
[WebAIM: Contrast Checker](https://webaim.org/resources/contrastchecker/?fcolor=808080&bcolor=E3E3E3)

(The result syncs with my own perception: I find that `.wy-menu-vertical li.current a` gray quite hard to read.)

---

<div class="post-metadata">

**Author:** ![bloom](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.openreferral.org/bloom/32/103_2.png) [@bloom](https://forum.openreferral.org/u/bloom)\
**Post date:** [November 14, 2022, 8:11pm UTC](https://forum.openreferral.org/t/rebuilding-our-project-documentation/259/4 "2022-11-14T20:11:41Z")

</div>

Thanks Margie!

I fixed the typo, and will add the Master\>Main change and the color contrast issue to our queue. much appreciated 🙂

---

<div class="post-metadata">

**Author:** ![bloom](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.openreferral.org/bloom/32/103_2.png) [@bloom](https://forum.openreferral.org/u/bloom)\
**Post date:** [December 7, 2023, 7:26pm UTC](https://forum.openreferral.org/t/rebuilding-our-project-documentation/259/5 "2023-12-07T19:26:42Z")

</div>

So this year, as described in this thread, we consolidated our Project Documentation from googledocs into our Github repo, so that it would [live](https://docs.openreferral.org/en/latest/initiative/index.html#) alongside [our Specification Documentation in ReadtheDocs](https://docs.openreferral.org/).

But we’ve since gotten feedback that the Technical Documentation site may be trying to do too much, in confusing ways – and the technical stewards have suggested that we try rebuilding our Project Documentation on our [OpenReferral.org](http://OpenReferral.org) site. This would at least keep us at only two documentation places, down from three (Wordpress, Google Docs, Github/ReadtheDocs) – and it means that that everything about the _project_ is found on the organization’s website while the ReadtheDocs site is just dedicated to technical specs for the _product_.

I’ve started testing that process out:

- I’ve added a [page for Our Values and Principles](https://openreferral.org/about/our-values-and-principles/) to Wordpress, which now shows up on the top menu.
- I’ve also created pages for [Organizational Overview](https://openreferral.org/about/organizational-overview/), [Assumptions and Hypothesis](https://openreferral.org/about/strategic-overview/assumptions-and-hypotheses/), and [Governance and Participation](https://openreferral.org/about/strategic-overview/governance-and-participation/). These pages are public but I haven’t decided where they should go in the Menu if at all.
- We’ve consolidated three different sets of FAQs into one set that is managed in a single document but published in two different places – technical questions on the ReadtheDocs site, and Organizational + Strategic questions on Wordpress.

I’m eager to hear feedback from the community on this. Do you agree that the Project Documentation should belong on our main organizational website, separate from the Product Documentation on ReadtheDocs? How might the Project Documentation be improved? Etc.

Thanks!  
greg
