Skip to content

docs: document the preferred language setting - #583

Merged
abdulrafey1 merged 2 commits into
mainfrom
refey/docs/lang-05-guide
Aug 12, 2026
Merged

docs: document the preferred language setting#583
abdulrafey1 merged 2 commits into
mainfrom
refey/docs/lang-05-guide

Conversation

@abdulrafey1

Copy link
Copy Markdown
Contributor

What

Documents the preferred-language setting for users and administrators.

Changes

  • docs(core): add a "Preferred language" section to the user management guide

How to Test

  1. make docs — builds with no warnings.
  2. Open site/guides/user-management/index.html and confirm the new section renders and its link to the configuration reference resolves to the DEFAULT_LANGUAGE anchor.

Notes

Documentation only, no code. The guide covers the supported list, reading and setting a user's choice, clearing it with an explicit null, the exact case-sensitive matching, and what happens to a stored tag that later leaves the allowlist.

It states plainly that AI-generated content does not use the preference — the setting is recorded and exposed for clients to read.

This description was written with the assistance of an LLM (Claude).

@abdulrafey1
abdulrafey1 force-pushed the refey/docs/lang-05-guide branch from bd99045 to 6167acc Compare August 11, 2026 23:23
@abdulrafey1
abdulrafey1 force-pushed the refey/docs/lang-05-guide branch from 6167acc to 790cd90 Compare August 11, 2026 23:31
@abdulrafey1
abdulrafey1 force-pushed the refey/docs/lang-05-guide branch from 790cd90 to 188a52d Compare August 12, 2026 06:37
Base automatically changed from refey/feat/lang-04-api to main August 12, 2026 08:29
abdulrafey1 and others added 2 commits August 12, 2026 13:29
Covers the supported list, how to read and set a user's choice, what null means,
and what happens to a stored tag once its language leaves the allowlist. The guide
is explicit that generated content does not consume the preference yet, so nothing
here promises behaviour the platform does not have. The DEFAULT_LANGUAGE reference
entry ships with the setting itself, so this change is guide-only.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Follows the endpoint dropping its auth gate on #582: documenting a Bearer header the
endpoint no longer wants would send readers looking for a token before they can render a
sign-in page in the right language. The /user/me examples keep theirs — those do need one.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@abdulrafey1
abdulrafey1 force-pushed the refey/docs/lang-05-guide branch from f0004b3 to 4498dae Compare August 12, 2026 08:29
@abdulrafey1
abdulrafey1 merged commit 26f7c49 into main Aug 12, 2026
6 checks passed
@abdulrafey1
abdulrafey1 deleted the refey/docs/lang-05-guide branch August 12, 2026 08:33
abdulrafey1 added a commit that referenced this pull request Aug 12, 2026
#582 and #583 landed on main as squash commits while this branch carried their original
commits, so git saw the same files added on both sides and flagged six conflicts where
there was one real question: which copy is current.

main's is. Its copies include the review fixes made after this branch was cut — the
languages endpoint dropped its auth gate, and the User schema moved back to the root
sparkth/schemas.py — so every file this branch does not own is resolved to main's version,
and the branch keeps only what it exists to change: the api_router assembly moving from
sparkth/api/v1/api.py into the package __init__.

Two of those needed more than a side chosen:

- api.py was modified in main (#582 registered the language router) and deleted here.
  Kept deleted; the nine include_router calls in __init__.py were verified identical to
  main's, prefixes and tags included, so the deletion drops no route.
- architectural_patterns.md is a union: main's amended shared-models rule, which now names
  User, plus this branch's rename of api.py to the package __init__. The re-export bullet
  is reworded because the rename leaves two different __init__.py roles in one section.

auth.py auto-merged without a conflict and silently kept this branch's pre-fix import,
dropping main's. Restored from main. Verified by diffing the whole tree against main: no
file outside the four this branch owns differs from it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.

2 participants