Moving CLIs docs reference to CLI repository #232
Replies: 1 comment 1 reply
-
As we discuss moving some docs outside docs.saleor.io, we need to address the point @patrys made yesterday about when moving something outside the main docs, we must ensure it is searchable through Algolia. But first, we need to know what we expect to be searchable through Algolia. Is it: If it's option a, all we need is a "CLI Reference" page in docs.saleor.io that redirects you to the GitHub documentation. |
Beta Was this translation helpful? Give feedback.
-
Context
We have distributed docs related to CLI
saleor/docs
https://docs.saleor.io/docs/3.x/clisaleor-cli
Docs structure
We'd like to have structure more or less following:
saleor/docs
Both docs and local reference should be well linked together.
Proposal
saleor-cli/docs
saleor-cli/docs
folder with.md
filesOne day, we can build them with Docosaurus or somehow embed into main docs website.
Reasoning
We need to maintain docs up to date - this is critical. Need to change 2-3 places each time we change our API will be hard to do.
By separating concerns, docs scope can focus on higher level, user-centric approach (business, problem oriented), while tools can maintain their own local docs, including installing, development etc.
Beta Was this translation helpful? Give feedback.
All reactions