Skip to content

AI-aided documentation#12

Merged
gne merged 4 commits intomainfrom
gne-ai-documentation
Dec 12, 2025
Merged

AI-aided documentation#12
gne merged 4 commits intomainfrom
gne-ai-documentation

Conversation

@gne
Copy link
Copy Markdown
Contributor

@gne gne commented Dec 5, 2025

No description provided.

@gne gne requested review from Copilot and havtorr December 9, 2025 09:21
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive inline documentation to TypeSpec model definitions across the codebase. The documentation clarifies the purpose and structure of models used in the eInnsyn (public records access) system, covering both web-facing models (access requests, user feedback) and archive-related models (documents, meetings, cases).

Key changes:

  • Enhanced model-level documentation with clear descriptions of each entity's purpose in the system
  • Added inline comments for all model properties explaining their role and content
  • Included English translations for Norwegian enum values to aid understanding

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
typespec/einnsyn.web.models.tsp Added documentation for web models including access requests (Innsynskrav), saved searches (LagretSoek), and user feedback (Tilbakemelding)
typespec/einnsyn.arkiv.models.tsp Added documentation for archive models covering documents (Dokumentbeskrivelse, Dokumentobjekt), organizational units (Enhet), registry entries (Journalpost), meetings (Moetemappe, Moetesak), and decisions (Vedtak)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@gne gne requested a review from havtorr December 10, 2025 15:48
@gne gne merged commit c6b3ae1 into main Dec 12, 2025
1 check failed
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.

3 participants