Improving the documentation: what's next? #1232
Replies: 4 comments 1 reply
-
The main missing bit is probably a proper documentation on the expectations of an implementation of a portal:
Additionally, I'd like to documentation on the internals of the code base, for instance: how does the document portal work? |
Beta Was this translation helpful? Give feedback.
-
I would also go ahead and document the tools available for debugging the portals: Doorknocker & ashpd demo comes to mind. Maybe also mention the available client side libraries |
Beta Was this translation helpful? Give feedback.
-
Contributors guide
Internals
|
Beta Was this translation helpful? Give feedback.
-
#1391 should get us closer to what has been suggested. Further improvements are always welcomed, of course! |
Beta Was this translation helpful? Give feedback.
-
Over the past month and a half, our documentation and website received major facelifts, and look wonderful now! Have a look:
However, this begs the question: is the current documentation enough? Is the website enough?
To me, the answer to both questions is a solid "probably not". But I also don't personally have much of an idea of what makes documentation good, what kind of contents people are looking for, who is even looking at our documentation, etc. Which is why I'm opening this up for broader discussion.
Some ideas that come to my mind:
I'd appreciate to learn if anyone has other ideas on how to improve that!
Beta Was this translation helpful? Give feedback.
All reactions