feat: Refactoring Documentation

[Grabauskas]

This pull request introduces several improvements and additions to the documentation for OneGround's ZGW API components, focusing on clearer structure, best practices, and expanded introductory material. The most important changes are summarized below.

New Documentation Structure and Introductory Guides:

• Added new introductory documentation pages for key ZGW API components, including Authorizations (AC), Catalogs (ZTC), and Documents (DRC). These pages provide overviews, key concepts, and links to official VNG standards. [1] [2] [3]
• Created a detailed guide on authentication, explaining how to obtain or generate JWT tokens for both Community and Unlimited editions, and included a code example for self-generating tokens.

Authorization and Configuration Guidance:

• Introduced a new section on configuration and tooling for Authorizations, outlining the use of authorization profiles, best practices (such as one Client ID per application and least privilege), and tool limitations/design decisions.
• Replaced the old, less structured authorizations documentation with the new, more comprehensive guides.

Documentation Consistency and Reference Updates:

• Updated internal documentation links to point to the new authentication guide, ensuring consistency across blog posts and technical documentation. [1] [2]

Formatting and Clarity Improvements:

• Added language identifiers to code blocks in blog posts for better syntax highlighting and clarity (e.g., javascript, jsonc). [1] [2] [3] [4]

---

New and Improved Documentation:

• Added introductory guides for Authorizations (AC), Catalogs (ZTC), and Documents (DRC), each explaining key concepts, workflows, and official standards. [1] [2] [3]
• Introduced a comprehensive authentication guide, covering token retrieval for both Community and Unlimited editions, and providing a self-generated JWT example.

Authorization Configuration Enhancements:

• Documented best practices and tool limitations for configuring authorizations, including the use of profiles and the rationale for enforcing one Client ID per application.
• Removed the old docs/authorizations.md in favor of the new, modular documentation.

Documentation Consistency:

• Updated references in blog posts and technical docs to point to the new authentication documentation for improved clarity and navigation. [1] [2]

Formatting Improvements:

• Improved code block formatting in blog posts by specifying language identifiers for better readability and developer experience. [1] [2] [3] [4]

[Copilot]

Pull request overview

This PR restructures the documentation by reorganizing content into logical categories (General, Authorization, Catalogs, Notifications, Documents) and introduces new introduction pages for each section. The changes improve navigation and discoverability while maintaining proper redirects from old URLs.

Changes:

• Reorganized sidebar structure into categorized sections with introduction pages
• Created introduction pages for AC, ZTC, NRC, and DRC components
• Moved existing documentation files into appropriate subdirectories
• Updated redirects to maintain backward compatibility with old URLs

Reviewed changes

Copilot reviewed 16 out of 22 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
sidebars.ts	Restructured documentation sidebar with new categories and nested items
docusaurus.config.ts	Added redirects for moved documentation pages
docs/usage-of-clientids.md	Deleted (content moved to docs/general/authentication.md)
docs/nrc-db-subscriptions.md	Deleted (content moved to docs/notifications/nrc-db-subscriptions.md)
docs/authorizations.md	Deleted (content moved to docs/authorization/ac-introduction.md)
docs/notifications/nrc-subscriptions-use.md	Added slug for consistent URL routing
docs/notifications/nrc-retry-architecture.md	Added slug for consistent URL routing
docs/notifications/nrc-introduction.md	New introduction page for Notifications system
docs/notifications/nrc-db-subscriptions.md	Reorganized content with improved formatting and structure
docs/general/authentication.md	Enhanced authentication documentation with improved code examples
docs/documents/drc-introduction.md	New introduction page for Documents system
docs/catalogs/ztc-introduction.md	New introduction page for Catalogs system
docs/authorization/ac-introduction.md	New introduction page for Authorizations system
docs/authorization/ac-configuration.md	New configuration guide for Authorization tooling
blog/2025-11-14-oauth2-token-endpoint.md	Updated link to moved authentication documentation
blog/2025-03-27-integrating-signing-software-with-zgw.md	Updated link and added language identifiers to code blocks

---

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