Skip to content

docs: refresh extending-the-web guide #541

Draft
eoaksnes wants to merge 4 commits into
stack/03-webfrom
stack/04-docs
Draft

docs: refresh extending-the-web guide #541
eoaksnes wants to merge 4 commits into
stack/03-webfrom
stack/04-docs

Conversation

@eoaksnes
Copy link
Copy Markdown
Collaborator

@eoaksnes eoaksnes commented May 9, 2026

Stack 4/4 — base: `stack/03-web` (#540)

Documentation updates for the new frontend architecture.

Stack

  1. chore(infra): IaC, compose, redis, oauth2-proxy baseline #538 stack/01-infra
  2. feat(api): add monitoring feature with track_events use case #539 stack/02-api
  3. refactor(web): full frontend architecture overhaul #540 stack/03-web
  4. stack/04-docs ← you are here

This pull request makes minor updates to the mkdocs.yml configuration 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:

  • Updated the Extending The Web navigation entry to use a multi-line format for consistency with other entries.
  • Enabled the pymdownx.snippets Markdown extension, allowing code snippets to be included from external files, and set its base_path and check_paths options for improved snippet management.

@eoaksnes eoaksnes requested a review from a team as a code owner May 9, 2026 11:44
eoaksnes added 3 commits May 9, 2026 13:55
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/*
@eoaksnes eoaksnes changed the title docs: refresh extending-the-web guide + add AUTH and FEATURE_TEMPLATE docs: refresh extending-the-web guide May 9, 2026
- 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
@eoaksnes eoaksnes marked this pull request as draft May 9, 2026 13:39
@eoaksnes eoaksnes force-pushed the stack/03-web branch 4 times, most recently from 3d4a891 to d03ffdb Compare May 20, 2026 07:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant