Have a documentation of the FE #219

Open
opened 2018-12-14 14:35:56 +00:00 by merry · 2 comments
Member

The description is WIP.

The issue is that there is no documentation in order to :

  • ramp up as faster as possible in the project
  • know or better understand what features or part of the app the issues refer to (which is not always clearly defined in issues description)
  • and because if documentation is well written and defined, it can help to write tests
  • ...

The documentation should answer these questions :

  • How the project is made
  • How the solution is designed
  • ...

Furthermore, I’m not talking about an user manual like "how to use pleroma website". This documentation is oriented for development purpose.
The "user manual" COULD BE a FAQ on the website and this is not the topic here.
Same thing for the README which is a how to local run the FE project.

It should be a wiki page.

As mentioned, the description is WIP, suggestions and help are very welcomed.

I plan to propose you something that describes more/better this ticket.

**The description is WIP.** The issue is that there is no documentation in order to : - ramp up as faster as possible in the project - know or better understand what features or part of the app the issues refer to (which is not always clearly defined in issues description) - and because if documentation is well written and defined, it can help to write tests - ... The documentation should answer these questions : - How the project is made - How the solution is designed - ... Furthermore, I’m not talking about an user manual like "how to use pleroma website". This documentation is oriented for development purpose. The "user manual" COULD BE a FAQ on the website and this is not the topic here. Same thing for the README which is a *how to local run* the FE project. It should be a wiki page. As mentioned, the description is WIP, suggestions and help are very welcomed. I plan to propose you something that describes more/better this ticket.

@hj do you want to do this or should i?

@hj do you want to do this or should i?
Owner

@lambadalambda user manual is made, but I don't quite understand the rest of the issue. Document the code or...?

@lambadalambda user manual is made, but I don't quite understand the rest of the issue. Document the code or...?
Sign in to join this conversation.
No milestone
No project
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
pleroma/pleroma-fe#219
No description provided.