# Organizing Hypha index pages
**URL:** https://we.hypha.app/t/organizing-hypha-index-pages/123
**Category:** đź“ť Documentation
**Created:** [July 29, 2021, 10:09pm UTC](https://we.hypha.app/t/organizing-hypha-index-pages/123 "2021-07-29T22:09:02Z")
**Posts on this page:** 7
**Page:** 1
### Author:  [@emlini](https://we.hypha.app/u/emlini)
#### Post date: [July 29, 2021, 10:09pm UTC](https://we.hypha.app/t/organizing-hypha-index-pages/123/1 "2021-07-29T22:09:02Z")
New topic, at @frjo’s request, about the purposes and content/organization of the index pages we have for Hypha.
As I understand, there are three pages:
- The [Hypha site index page](https://github.com/HyphaApp/hypha-site/blob/main/content/_index.md)
- The [Hypha documentation index page](https://github.com/HyphaApp/hypha-docs/blob/main/README.md)
- The [Hypha github repository README page](https://github.com/HyphaApp/hypha/blob/main/README.md)
_Questions we need to answer/things to be agreed on:_
1. What is the purpose of each page? (who will access it, what are their needs)
2. What content should be a part of each page? (this will obviously depend on the answer to (1)
3. Where will answers to / decisions regarding these questions live after we’ve hashed them out in this forum? (possibly on the great [miro board](https://miro.com/app/board/o9J_l5JCRjs=/) @bernard created laying out the architecture of the first two sites?)
Have I covered everything?
---
### Author:  [@frjo](https://we.hypha.app/u/frjo)
#### Post date: [July 30, 2021, 8:53am UTC](https://we.hypha.app/t/organizing-hypha-index-pages/123/2 "2021-07-30T08:53:44Z")
@bernard ideas here [Link to documentation on Hypha.app - #7 by bernard](https://we.hypha.app/t/link-to-documentation-on-hypha-app/85/7) are a very good start I think, maybe you can paste them in here?
The **Hypha site** is a broad introduction for anyone with links to documentation and GitHub. I would really like to see a screencast or similar here showing of Hypha in the future.
The **GitHub README** is for developers. It should explain what the system is about, who is behind it and have links to documentation etc.
All roads then leads to the **documentation site**. This is for really interested people and most importantly for users of Hypha that needs to get stuff done.
I’m really happy that Hypha documentation is taking shape! It will greatly improve the users experience. It will also help improve Hypha itself, if something is hard to document it is most likely hard to use and need some redesign.
---
### Author:  [@blah](https://we.hypha.app/u/blah)
#### Post date: [July 30, 2021, 2:41pm UTC](https://we.hypha.app/t/organizing-hypha-index-pages/123/3 "2021-07-30T14:41:15Z")
Thanks for raising this here @emlini and also awesome to see docs growing! +1 to docs index focus being on docs layout/structure and also how to get help. great example to me is [Django documentation | Django documentation | Django](https://docs.djangoproject.com/en/3.2/)
---
### Author:  [@emlini](https://we.hypha.app/u/emlini)
#### Post date: [July 30, 2021, 5:53pm UTC](https://we.hypha.app/t/organizing-hypha-index-pages/123/4 "2021-07-30T17:53:08Z")
> [@blah](#):
>
> Django documentation | Django documentation | Django
Thanks for this example–I’ve been hoping to solicit documentation examples folks really like, so I can model Hypha’s documentation on them.
---
### Author:  [@emlini](https://we.hypha.app/u/emlini)
#### Post date: [August 3, 2021, 1:46am UTC](https://we.hypha.app/t/organizing-hypha-index-pages/123/5 "2021-08-03T01:46:09Z")
I’ll summarize some of the things folks have said here, but I’d love to have the info in a place where we can easily edit/update it according to comments. My mind goes to “Google Doc” but are there better suggestions? (It occurs to me that the miro board, though awesome for site architecture, may not be the best place for the amount of detail we want to include–or maybe I’m just not familiar enough with how to use it)
**(A) Hypha site index page**
- PURPOSE: high-level introduction to Hypha
- USERS: Anyone (_can/should we specify types of users in more detail?_)
- CONTENT: The stuff that’s on the page now + possibly a screencast Hypha demo (@frjo’s suggestion, I like this)
**(B) Hypha documentation index page**
- PURPOSE: instructions for using Hypha
- USERS: adopters, potential adopters, people tearing their hair out trying to figure out how to do something
- CONTENT: @blah and I both made edits to this, see new version [here](https://docs.hypha.app).
**(C) Hypha github repository README page**
- PURPOSE: house code for Hypha core & issues list
- USERS: developers/maintainers & deployers for organizations who adopt Hypha
- CONTENT: system overview, maintainer info, links to documentation
---
### Author:  [@frjo](https://we.hypha.app/u/frjo)
#### Post date: [August 3, 2021, 7:35am UTC](https://we.hypha.app/t/organizing-hypha-index-pages/123/6 "2021-08-03T07:35:33Z")
**(A) Hypha site index page**
I think we can remove the sections “About the Hypha team” and “Support Hypha”.
This page also should be made to look nice.If someone can suggest a nice look for the page I can implement it. Producing a nice screencast will take time but some screenshots maybe, and some colour?
(The current look is the my Zen theme for Hugo, it is a solid base theme but not ment to be used without some nice custom styles.)
---
### Author:  [@bernard](https://we.hypha.app/u/bernard)
#### Post date: [August 3, 2021, 12:15pm UTC](https://we.hypha.app/t/organizing-hypha-index-pages/123/7 "2021-08-03T12:15:24Z")
> [@emlini](#):
>
> As I understand, there are three pages:
>
> - The [Hypha site index page](https://github.com/HyphaApp/hypha-site/blob/0e3780bb459be731738fbe48f7408d4a62b3d03a/content/_index.md)
> - The [Hypha documentation index page](https://github.com/HyphaApp/hypha-docs/blob/1ee8f1f5b653fc5d40b100bf33c0673241db7773/README.md)
> - The [Hypha github repository README page](https://github.com/HyphaApp/hypha/blob/8bbeeb4fa40235de871557d9165b64911742fac6/README.md)
## Proposed new IA for documentation
(See the original on [the Miro board](https://miro.com/app/board/o9J_l5JCRjs=/?moveToWidget=3074457362032903044&cot=14))
Assuming no objections, I want us to organise the current [development](https://docs.hypha.app/contributing) under a contributing page which includes other ways to contribute. Development is not the only way to contribute to an open source project.
## 1. Hypha site index page
Link: [Hypha site index page](https://github.com/HyphaApp/hypha-site/blob/0e3780bb459be731738fbe48f7408d4a62b3d03a/content/_index.md)
### What is the purpose of each page?
still workng on this
### What content should be a part of each page?
still workng on this
## 2. Hypha documentation index page
Link: [Hypha documentation index page](https://github.com/HyphaApp/hypha-docs/blob/1ee8f1f5b653fc5d40b100bf33c0673241db7773/README.md)
### What is the purpose of each page?
To provide detailed information to the 5 user types below, so they can get started with Hypha.
### Who will access it? What are their needs?
**Technical implementors**
They need:
- an overview of technical aspects of hypha
- hypha security (audit history and outcomes)
- how to upgrade hypha
- how to administer hypha
- how to maintain hypha
- how to deploy hypha
- something else?
**Developers**
They need:
- how to contribute code to Hypha
- something else?
(These pages do not exist, but I propose they are created)
**Documentation writers**
They need:
- how to contribute to Hypha documentation
**UX Designers**
They need:
- how to contribute UX design to Hypha
**Localisation/translators**
They need:
- how to translate Hypha
**Staff (who are using Hypha for their work) from organisations who have adopted Hypha**
They need:
- general information about how **Hypha whitelabel** works. It will be a beginning for the adopting organisation if they want tocreate their own documentation. i.e.This information **will not** be tailored to their organisation.
- something else?
### What content should be a part of each page?
TBC
I think:
- the technical implementor, and developers pages are in pretty good shape.
@allan @maxpearl @kfogel @frjo anything you’d add?
- the documentation writer, designer, localisation pages don’t exist so they need to be added. I think their needs are similar - essentially how to get started on contributing.
## 3. Hypha github repository README page
Link: [Hypha github repository README page](https://github.com/HyphaApp/hypha/blob/8bbeeb4fa40235de871557d9165b64911742fac6/README.md)
### What is the purpose of the readme page? Who will access it? What are their needs?
It will be:
- the same as the index page of doc.hypha.app
- a pointer to each section in the docs.
## Where will answers to / decisions regarding these questions live after we’ve hashed them out in this forum?
The [miro board](https://miro.com/app/board/o9J_l5JCRjs=/) is a good place to have this organised. And the changes will then be made in the git repo.
* * *
Derp - I was writing this post and didn’t refresh to see the additions by @emlini and @frjo. 🤦‍♂️