docs: refresh extending-the-web guide #541
Draft
eoaksnes wants to merge 4 commits into
Draft
Conversation
Infra & deployment topology: - IaC: app-registration + resources deploy scripts, bicep updates - docker-compose: align dev/override, wire oauth2-proxy service - radixconfig: updated config - redis: standalone Dockerfile + entrypoint - secrets: README and .gitignore - root: env template, gitattributes, release-please, mise lint task, dependabot, pre-commit hooks OAuth2 proxy & nginx: - web/oauth2: dedicated Dockerfile, entrypoint, oauth2-proxy config - web/nginx: oauth2 auth_request/redirect snippets, security headers, default.conf updates - web/Dockerfile: align with oauth2 split
- features/monitoring: new feature module + track_events endpoint - app.py / authentication / config: wire up monitoring + tweaks - features/todo/use_cases: minor adjustments - Dockerfile + install-equinor-certificates.sh: build infra - openapi.json + uv.lock + pyproject: dependency updates
Tooling:
- eslint flat config + biome update
- yarn .yarnrc + sdks for editor support
- package.json + yarn.lock dependency bumps
- tsconfig, vite, vitest, openapi-ts config refresh
- mise: add lint:web:query task (TanStack Query lint)
- .gitattributes: mark routeTree.gen.ts and api-generated/ as linguist-generated
- docker-compose.override: pass VITE_AUTH + VITE_TELEMETRY into dev SPA
Generated SDK:
- Move api/generated -> api-generated
- Add @tanstack/react-query.gen.ts (query/mutation hooks)
- Add zod.gen.ts (runtime schema validation)
Shared platform foundation:
- shared/platform/api: configureApiClient, query client factory, ApiError
- shared/platform/auth: current/anonymous user, reauth flow, session watcher
- shared/platform/telemetry: AppInsights/console/noop backends + error boundary
- shared/platform/{theme,toast,feature-flags,access-control}
- shared/components: EmptyState, ErrorPanel, IconButton, LoadingState, PageHeader, Popover
- config/: env, accessControl, featureFlags
- mocks/: MSW server + handlers
- setupTests.ts updated
App shell + Todos cutover:
- app/bootstrap: Providers, ApplicationError, createQueryClient
- app/error-pages: Forbidden/NotFound/StatusPage/RouteErrorBoundary/UnexpectedError
- app/layout: RootLayout, Header, VersionText
- app/routes + routeTree.gen.ts (TanStack Router)
- app/styles, app/auth/SessionExpiredDialog
- features/todos: api (queries/mutations/keys/invalidations/schema), pages/TodosPage with NewTodoForm, TodoItem, TodoList, TodosFilter
- index.tsx + index.html: new bootstrap
- Removed legacy: App.tsx, router.tsx, auth.ts, common/components/*, contexts/TodoContext, hooks/useTodoAPI, pages/TodoListPage, features/todos/todo-list/*
- docs/extending-the-web: align with new TanStack Router + features/* layout - mkdocs.yml: nav adjustments - web/docs/AUTH.md: oauth2-proxy + session reauth flow - web/docs/FEATURE_TEMPLATE.md: scaffolding template for new features
3d4a891 to
d03ffdb
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stack 4/4 — base: `stack/03-web` (#540)
Documentation updates for the new frontend architecture.
Stack
This pull request makes minor updates to the
mkdocs.ymlconfiguration file for documentation. The changes clarify the formatting for a navigation item and enable the use of code snippets in Markdown files.Documentation configuration improvements:
Extending The Webnavigation entry to use a multi-line format for consistency with other entries.pymdownx.snippetsMarkdown extension, allowing code snippets to be included from external files, and set itsbase_pathandcheck_pathsoptions for improved snippet management.