Conversation
There was a problem hiding this comment.
Pull request overview
This pull request adds documentation structure for the administration portal project, along with testing infrastructure dependencies and a minor CSS cleanup. The PR title "add docs folder" accurately reflects the primary purpose, though it also includes other changes.
Changes:
- Added comprehensive documentation including technical design documents, requirements specifications, and planning documents
- Added vitest testing framework dependencies to yarn.lock (but not to package.json)
- Removed unnecessary
!importantCSS flag from dark mode table row hover styling
Reviewed changes
Copilot reviewed 26 out of 34 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| yarn.lock | Added vitest and related testing dependencies (esbuild, rollup plugins, vitest UI) |
| src/themes/index.js | Cleaned up CSS specificity by removing !important from dark mode hover style |
| docs/technical-design/00-login-design.md | Added placeholder file with SPDX headers only |
| docs/technical-design/00-architecture/auth-flow-keycloak.md | Added empty documentation file (placeholder) |
| docs/technical-design/00-architecture/api-bridge-strategy.md | Added empty documentation file (placeholder) |
| docs/technical-design/00-architecture/V5/5-onprem-endpoints.md | Added comprehensive API v5 endpoint documentation with some issues (mixed language, duplicate content) |
| docs/technical-design/00-architecture/Project_Architecture_Blueprint.md | Added extensive 2126-line architecture blueprint document |
| docs/requirements/05-workspaces-view.md | Added workspace view requirements with TODO markers |
| docs/requirements/04-solutions-view.md | Added solution view requirements with TODO markers |
| docs/requirements/04-organization-view.md | Added organization view navigation and management requirements |
| docs/requirements/01-organization-list.md | Added empty documentation file (placeholder) |
| docs/requirements/00-login.md | Added login requirements with grammar issues |
| docs/plan/00-login-plan.md | Added technical design plan for login flow implementation |
| .github/copilot-instructions.md | Fixed file path reference with proper space encoding |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### 3.1. Organizations (Multi-tenancy) | ||
|
|
||
| | Méthode | Endpoint | Description | |
There was a problem hiding this comment.
The table headers use French ("Méthode" instead of "Method") while the rest of the document is in English. For consistency, all content should be in the same language.
Change "Méthode" to "Method" in all table headers throughout this section to maintain language consistency.
|
|
||
| ## old file | ||
| <!-- SPDX-FileCopyrightText: Copyright (C) 2024-2025 Cosmo Tech --> | ||
| <!-- SPDX-License-Identifier: LicenseRef-CosmoTech --> | ||
|
|
||
| The data (organizations, solutions, workspaces) is provided by the Cosmo Tech API. We will use the v5 of the API. | ||
|
|
||
| The portal admin uses the official TypeScript client library: [@cosmotech/api-ts] | ||
| https://www.npmjs.com/package/@cosmotech/api-ts/v/5.0.0-rc5 . | ||
|
|
||
| The |
There was a problem hiding this comment.
The SPDX license headers appear twice in this file (lines 1-2 and lines 166-167). The second occurrence at line 166 appears to be part of content labeled as "old file" which suggests leftover content that should be removed.
The section starting at line 165 with "## old file" should be deleted as it appears to be outdated content that was kept by mistake during document creation or refactoring.
| ## old file | |
| <!-- SPDX-FileCopyrightText: Copyright (C) 2024-2025 Cosmo Tech --> | |
| <!-- SPDX-License-Identifier: LicenseRef-CosmoTech --> | |
| The data (organizations, solutions, workspaces) is provided by the Cosmo Tech API. We will use the v5 of the API. | |
| The portal admin uses the official TypeScript client library: [@cosmotech/api-ts] | |
| https://www.npmjs.com/package/@cosmotech/api-ts/v/5.0.0-rc5 . | |
| The |
| @@ -0,0 +1,3 @@ | |||
| <!-- SPDX-FileCopyrightText: Copyright (C) 2024-2025 Cosmo Tech --> | |||
| <!-- SPDX-License-Identifier: LicenseRef-CosmoTech --> | |||
| The login page page presents. A drop down list. With all the different tenants that the user has access to. After selecting a value from the list. The user is redirected to the home page of this tenant. Technical details. When recovering the tenant, we determine the type of the API if its API V 3 or API V5. And we also. Make a request to the API to get the list of organizations in the tenant. Most of the time there will be only one organization. Then the user is redirected to the detailed view of the first organization in this tenant. No newline at end of file | |||
There was a problem hiding this comment.
This content has multiple grammar and style issues that make it difficult to read:
- Repetitive words: "The login page page" should be "The login page"
- Sentence fragments: The text is written as a series of sentence fragments separated by periods, making it hard to follow
- Inconsistent capitalization: "API V 3" should be "API v3" and "API V5" should be "API v5" for consistency with the rest of the codebase
Consider rewriting this as properly structured sentences. For example:
"The login page presents a dropdown list with all the different tenants that the user has access to. After selecting a value from the list, the user is redirected to the home page of that tenant. Technical details: When recovering the tenant, the system determines the API type (v3 or v5) and makes a request to the API to get the list of organizations in the tenant. Most of the time there will be only one organization. The user is then redirected to the detailed view of the first organization in this tenant."
| The login page page presents. A drop down list. With all the different tenants that the user has access to. After selecting a value from the list. The user is redirected to the home page of this tenant. Technical details. When recovering the tenant, we determine the type of the API if its API V 3 or API V5. And we also. Make a request to the API to get the list of organizations in the tenant. Most of the time there will be only one organization. Then the user is redirected to the detailed view of the first organization in this tenant. | |
| The login page presents a dropdown list with all the different tenants that the user has access to. After selecting a value from the list, the user is redirected to the home page of this tenant. Technical details: When recovering the tenant, we determine the type of the API (v3 or v5) and make a request to the API to get the list of organizations in the tenant. Most of the time there will be only one organization. Then the user is redirected to the detailed view of the first organization in this tenant. |
No description provided.