Forem's Documentation

jarekp profile image Jarek Piotrowski ・1 min read

Hello Forem Community!
I’m working on a new tool that solves the main problem we currently see in documentation: it is very far from the codebase!

That is why we develop a tool that enables linking code with documentation, so that:

  1. developers or technical writers responsible for Forem documentation can get notifications on Github when a code that is linked to docs changes,
  2. new contributors, while reading documentation, can quickly view source code connected to a given functionality so that they can quickly understand the codebase.

I see that you use mainly markdown with GitBook. Could you please refer me to a person that is responsible for docs at Spack? I would love to ask a couple of questions about your documentation set-up.

Discussion (0)

Editor guide