actual_db_schema icon indicating copy to clipboard operation
actual_db_schema copied to clipboard

Document all features of the gem

Open ka8725 opened this issue 1 year ago • 1 comments

Research available options for creating documentation. A good example of well-structured documentation is SpreeCommerce Docs.

We don’t need to use the same tools as SpreeCommerce, but we want a similar clean and user-friendly UI. The solution should support easy page creation, with a hierarchical navigation tree on the left and built-in search functionality.

Additionally, the chosen solution must be open-source, free of charge, and allow custom domain configuration at no cost. Ideally based on Ruby.

Consider this solution - https://github.com/just-the-docs/just-the-docs

Docs structure:

  • Getting started
  • Why use it
  • Features
  • Installation
  • Config
  • Changelog
  • Search
  • FAQ

ka8725 avatar Feb 15 '25 11:02 ka8725

Consider this - https://vitepress.dev/

ka8725 avatar Feb 15 '25 23:02 ka8725