Skip to content

docs(readme): refresh root README and add French peer (AB#2229)#9

Merged
emmanuelknafo merged 1 commit into
mainfrom
feature/2229-readme-refresh-and-fr-peer
May 1, 2026
Merged

docs(readme): refresh root README and add French peer (AB#2229)#9
emmanuelknafo merged 1 commit into
mainfrom
feature/2229-readme-refresh-and-fr-peer

Conversation

@emmanuelknafo
Copy link
Copy Markdown
Contributor

Summary

Refreshes the root README to fully reflect the current codebase, infrastructure, workflows, scripts, tests, slides build, boards seed, and adds a distinct README.fr.md as its French peer so the bilingual parity rule from CONTRIBUTING.md is honoured at the repo root.

What changed

README.md

  • Added a bilingual switcher row at the top linking to README.fr.md.
  • Documented the full architecture (mermaid) including UAMI, VNet, private endpoints, Application Insights and Log Analytics.
  • Pinned the current tech stack: .NET 10 (10.0.100, latestFeature), EF Core 10, Microsoft.Data.SqlClient 6.1.1, Azure.Monitor.OpenTelemetry.AspNetCore 1.4.0 (SamplingRatio = 1.0, TracesPerSecond = null), Microsoft.Identity.Web 3.5.0, Azure.Identity 1.14.2.
  • Expanded repository navigation to cover src/, tests/ (xUnit + Locust + Playwright), infra/main.bicep + infra/modules/ + infra/scripts/, scripts/, slides/, boards/, data/seed/, .github/workflows/, .azuredevops/pipelines/ and .devcontainer/.
  • Added quick-start, local-dev (in-memory fallback), tests, lab map, Bicep parameters/outputs, and CI/CD sections.
  • Documented the post-provision UAMI-grant + App Service restart pattern introduced by AB#2228 / fix(workflows): restart App Services after UAMI SQL grant (AB#2228) #8 in both the GitHub Actions and Azure DevOps Pipelines flows.

README.fr.md (new)

  • Mirrors every section of README.md in Quebec French.
  • Cross-linked back to README.md at the top.
  • Same markdownlint-disable header preserved.

Validation

  • markdownlint passes on both files (no problems reported by the editor diagnostics).
  • All cross-links use workspace-relative paths.

Fixes AB#2229

Rewrite the root README.md to fully reflect the current codebase and
infrastructure, and add a distinct README.fr.md as its French peer so
the bilingual parity rule from CONTRIBUTING.md is honoured at the repo
root.

README.md updates
- Add bilingual language switcher row linking to README.fr.md.
- Document the full architecture (mermaid) including UAMI, VNet, private
  endpoints, Application Insights and Log Analytics.
- Pin the current tech stack: .NET 10 (10.0.100, latestFeature), EF Core
  10, SqlClient 6.1.1, Azure.Monitor.OpenTelemetry.AspNetCore 1.4.0
  (SamplingRatio = 1.0, TracesPerSecond = null), Microsoft.Identity.Web
  3.5.0, Azure.Identity 1.14.2.
- Expand repository navigation to cover src/, tests/ (xUnit + Locust +
  Playwright), infra/main.bicep + infra/modules/ + infra/scripts/,
  scripts/, slides/, boards/, data/seed/, .github/workflows/,
  .azuredevops/pipelines/ and .devcontainer/.
- Add quick-start, local-dev (in-memory fallback), tests, lab map,
  Bicep parameters and outputs, and CI/CD sections.
- Document the post-provision UAMI-grant + App Service restart pattern
  introduced by AB#2228 / PR #8 in both the GitHub Actions and Azure
  DevOps Pipelines flows.

README.fr.md
- New file mirroring every section of README.md in Quebec French.
- Cross-linked back to README.md at the top.
- Same markdownlint-disable header preserved.

Fixes AB#2229
@emmanuelknafo emmanuelknafo merged commit 9f2cd82 into main May 1, 2026
9 of 10 checks passed
@emmanuelknafo emmanuelknafo deleted the feature/2229-readme-refresh-and-fr-peer branch May 1, 2026 01:53
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