Mirror of the Rel4tion website/wiki source, view at <http://rel4tion.org>
Clone
HTTPS:
git clone https://vervis.peers.community/repos/yEzqv
SSH:
git clone USERNAME@vervis.peers.community:yEzqv
Branches
Tags
13.mdwn
[[!template id=ticket class=task]]
[[!meta title=""“Organize”about" texts"""]]
Issue
There is a lot of intro material which explains what Rel4tion is. There are many sides to it: The concepts of Smaoin, semantic information languages, datastores, APIs, tools, applications, network, federation… many aspects which need to be explained well.
It’s like GNOME comes - or once came - with an introductory video which plays the first time you log in. Rel4tion needs both an intro and a good set of texts/manuals/help pages.
Plan
In this ticket I’d like to organize the new documentation structure. Find where the current info is, make a list of things that need to be told, plan how and where to place them, and eventually start writing while reusing the pieces I already wrote.
So where are the help pages currently?
- [[/projects/Smaoin]] has design and theory pages. But the definition and tutorial still need to be written.
- [[/about]] section
- [[/use-cases]]
- [[/projects/Rel4tion]] project page
- More? TODO find them all and finish this list
IDEA: Maybe have nothing under about/, and instead just have the about page link to various over pages? The whole wiki is one huge about, so maybe it’s a better idea not to have dedicated about/ pages. Just put them in the best location and link from about/
What should the about section say and talk about?
- Vision
- Purpose
- History
- People
- Name
Things which are part of the design and the about section should contain too:
- Concepts
- Project structure and component overview
- Various intro materials: presentation slides, articles, etc.
- Social impact
QUESTION: Should all these thing be in /about or under /projects/rel4tion?
ANSEWR: NO big deal here, but maybe prefer /projects/rel4tion to keep the top level clean. It already has many things. Remember the wiki is for many things, not just Rel4tion itself (e.g. other projects like the collection and general decentralized app ideas), so keeping Rel4tion things under /projects can help organize the wiki better.
Result
None yet.