feat(docs): add console docs scope tracker - #22
Conversation
|
@SyedaFatimaKazmi PR doc deploy will soon be available for review on https://stakater.github.io/sco-docs/sco-console-docs-discovery |
|
@SyedaFatimaKazmi Image is available for testing. |
|
@SyedaFatimaKazmi PR doc deploy will soon be available for review on https://stakater.github.io/sco-docs/sco-console-docs-discovery |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| Consumer 8 active + 2 deferred · Provider 2 · Cross-cutting 2. | ||
|
|
||
| > ⚠️ **Mocks:** several console areas serve mock data in the current build. | ||
| > Disable mocks before writing/screenshotting so the public docs don't expose |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[1])
Suggestions: , so
URL: https://languagetool.org/insights/post/comma-before-and/
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=1
Category: PUNCTUATION
|
|
||
| - [ ] **C1** `overview.md` — *(fill)* what the console is, layout/navigation, role-based views, Standard vs Advanced mode | ||
| - [ ] **C2** `accessing-the-console.md` *(new)* — logging in, choosing organisation/project context · **standalone page, cross-linked from `authentication/logging-in.md`** | ||
| - [ ] **C3** `dashboard.md` — *(fill)* dashboard widgets, key metrics, recent activity · 🅼 **disable mock data first** — only document real widgets |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
Do not mix variants of the same word (‘organization’ and ‘organisation’) within a single text. (EN_WORD_COHERENCY)
Suggestions: organisations
Rule: https://community.languagetool.org/rule/show/EN_WORD_COHERENCY?lang=en-US
Category: MISC
|
@SyedaFatimaKazmi Image is available for testing. |
2 participants
Map the console documentation scope across cloud-consumer and cloud-provider perspectives as a tick-off action plan.
14 pages total: 10 consumer (fill 6 existing Console placeholders + 4 new), 2 provider UI-control placeholders (WIP), 2 cross-cutting (install/access check, mkdocs nav). Each line becomes an epic subtask.
note: plan document lives outside content/ so it does not publish as a doc page
[no need to merge this pr]