Forem Creators and Builders 🌱

Discussion on: What should Forem use for documentation?

Collapse
 
akhil profile image
Akhil Naidu • Edited

In my perspective, the present documentation is excellent, and refining it regularly is enough for people who are aware of so-called technical knowledge, i.e., experience with ruby on rails, Heroku, and many other production-oriented alternatives.

So the focus should not be on the formal documentation, which Forem already had. Also, it should not be on the informal and static documentation, as some video tutorials - it's tough to update.

The main focus should be on semi-formal documentation, like guides on:

  1. Setting up a Forem development instance in a local machine.
  2. How to migrate a local Forem development instance to Heroku or own VPS or some other alternatives as to the production instance
  3. Advantages and disadvantages of having a Forem instance in VPS, Local machine separately.
  4. Entire development to production of Forem in a single digital ocean droplet or VPS.

This kind of semi-formal documentation, also known as guides 😜, are beneficial to the majority of the less experienced developers or beginners.

I didn't randomly come up with this idea; I am an undergraduate who is working with some of my friends to do something useful in the time of this ongoing pandemic. I always thought of having a blogging platform with twitter-like features but found none. Forem is the best alternative for me to begin. So we decided to work on it but failed 😏, almost three months have been passed but can't have a production-based Forem instance 😔

Collapse
 
akhil profile image
Akhil Naidu

Also, this kind of guide needs no new platform. I always felt that Dev is a platform for developers to share their knowledge through blogging.

In the case of Forem, I expect such a guide from the Forem team itself. It is a guide that utilizes the potential of Forem; it acts as a showcase on what a Forem instance can do.

Collapse
 
tofraley profile image
Taylor Fraley • Edited

I agree. From what I understand, the Discourse community uses Discourse for their documentation. Maybe Forem could do the same. Use Forem.dev or another Forem site. This would make a lot of sense for living documentation. Discussions can become the documentation. When the discussion becomes too lengthy, it could be summarized into a new post.
Any thoughts on why Forem might not be suitable for this?