Designing the documentation #78

New Issue

decentral1se · 2021-06-19T08:38:03Z

decentral1se commented

2021-06-19 08:38:03 +00:00

I think it would be great to think about how to design the documentation now that we have time and money for it. In our proposal we said we'd do:

High-quality documentation. We want to provide accessible documentation for all users of Co-op Cloud, so that both the technical and social elements of the project are well-understood.

I am thinking about some examples that I thought were wonderful:

Any other examples people know about? It might be cool to try to get in touch with people who are doing this kind of documentation and see if they want to work with us.

We might want to orientate it around "roles", so, individual, tech co-op, tech collective.

mkdocs is pretty rad I think, so I am fine with sticking with it as the technical tool underneath if others are. Also we need to think about https://git.autonomic.zone/coop-cloud/organising/issues/74.

I think it would be great to think about how to design the documentation now that we have time and money for it. In our proposal we said we'd do: > High-quality documentation. We want to provide accessible documentation for all users of Co-op Cloud, so that both the technical and social elements of the project are well-understood. I am thinking about some examples that I thought were wonderful: - https://datprotocol.github.io/how-dat-works/ - https://ssbc.github.io/scuttlebutt-protocol-guide/ - https://handbook.scuttlebutt.nz/ - https://yunohost.org/ - https://docs.drone.io/ - https://docs.djangoproject.com/ Any other examples people know about? It might be cool to try to get in touch with people who are doing this kind of documentation and see if they want to work with us. We might want to orientate it around "roles", so, individual, tech co-op, tech collective. `mkdocs` is pretty rad I think, so I am fine with sticking with it as the technical tool underneath if others are. Also we need to think about https://git.autonomic.zone/coop-cloud/organising/issues/74.

decentral1se added this to the (deleted) milestone 2021-06-19 08:38:03 +00:00

decentral1se added the

documentation

label 2021-06-19 08:38:03 +00:00

decentral1se commented

2021-06-21 17:26:33 +00:00

I really like the idea of the "Public Stack" and its docs:

http://publicstack.net:8080/layers/

You can click on the blocks on the left and it unpacks them. That is nice.

I really like the idea of the "Public Stack" and its docs: > http://publicstack.net:8080/layers/ You can click on the blocks on the left and it unpacks them. That is nice.

❤️ 1

decentral1se commented

2021-07-01 13:05:17 +00:00

Manga assisted docs!

https://verifpal.com/res/pdf/manual.pdf

Manga assisted docs! > https://verifpal.com/res/pdf/manual.pdf

decentral1se added this to the (deleted) milestone 2021-09-09 14:29:20 +00:00

decentral1se commented

2021-10-18 14:38:55 +00:00

Chatted with Simon today who is gonna take on this work! 🚀

decentral1se added this to the Beta release (software) project 2021-10-18 14:39:02 +00:00

decentral1se referenced this issue from toolshed/docs.coopcloud.tech

2021-10-28 20:07:17 +00:00

Add some architecture diagrams #17

decentral1se referenced this issue from toolshed/docs.coopcloud.tech

2021-11-18 18:42:01 +00:00

Menu Perestroika Proposal: App Deployer / Recipe Maintainer / Community Member #26

decentral1se commented

2021-12-12 16:55:34 +00:00

New idea in the air: merge docs.coopcloud.tech / coopcloud.tech in a single hugo site which supports the new design for the home page and has the docs, blog, etc. all in the one spot with the same design.

kawaiipunk modified the project from Beta release (software) to Beta release (design)

2022-01-13 14:07:40 +00:00

3wordchant commented

2022-01-27 13:58:39 +00:00

Simon is working on this.

decentral1se closed this issue

2022-06-17 09:42:25 +00:00

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: toolshed/organising#78