Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Nitwel
left a comment
There was a problem hiding this comment.
Not sure if this is the right place to put these. content/configuration is mainly for documenting env vars. We should probably create a new page for cli docs if there doesn't exist one already and link to that in this file instead.
Good point! I initially thought about creating a dedicated CLI reference page, but there isn't one yet and it would mean documenting all existing commands. I'll simplify the section here to keep it minimal, and we can track a separate PR for a proper CLI page ? |
|
I have simplified the documentation |
|
If possible please document the whole cli, shouldn't take that long with the help of AI and otherwise our docs will stay bad forever if we don't put in the time to fill these holes when they arise. |
Alright, let’s create the entire CLI documentation here then 😅 |
Nitwel
left a comment
There was a problem hiding this comment.
I'd say we move the cli docs under guides/connect as that is more fitting there. Other than that, the changes look good to me. 👍
Makes sense to move it out of configuration. I checked guides/connect though and it's mostly API-related stuff (auth, SDK, query params, filter rules). The CLI commands are more ops/admin (bootstrap, migrate, cache clear, start) |
|
Our docs structure is definitely very badly chosen so that we often need to document something that doesn't belong in any of our existing categories like this. I picked |
Yeah the docs structure makes this tricky. CLI commands are really about instance management (start, bootstrap, migrate, cache clear) and not really about connecting to the API. For now, what about keeping it under configuration/ since that's where ops-related stuff already lives (migrations, cache, database)? We can always move it later if a manage/operations or similar category gets created |
Following this PR