Skip to content

106 feature documentatioin - #171

Merged
hizclick merged 7 commits into
mainfrom
106-feature-documentatioin
Aug 5, 2026
Merged

106 feature documentatioin#171
hizclick merged 7 commits into
mainfrom
106-feature-documentatioin

Conversation

@hizclick

@hizclick hizclick commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

This PR updates the Cartographer App documentation to reflect the latest application changes. It aligns the user and technical documentation with the current user interface, authentication workflow, image-import features, deployment configuration, and newly introduced components.

Changes

User documentation

  • Updated the installation and setup instructions.
  • Updated the user interface documentation.
  • Documented current user actions and workflows.
  • Updated image-import instructions.
  • Updated footer-related documentation.
  • Clarified local development and application configuration.

Technical documentation

  • Updated documentation for:
    • AppHeader
    • AppFooter
    • AppSidebar
    • LoadXMLModal
  • Added information about new and updated application components.
  • Aligned component documentation with the current Vue implementation.
  • Updated VuePress navigation and sidebar configuration.

Authentication and Git integration

  • Documented the updated GitHub OAuth authentication flow.
  • Updated configuration guidance for local environment variables.
  • Reflected the move to the dedicated authentication store module.
  • Documented repository loading and commit-related workflows.

Deployment

  • Updated Docker deployment instructions.
  • Documented runtime environment configuration.
  • Added information about Docker Compose usage.
  • Updated nginx configuration guidance.
  • Documented public path, imprint, and collaborator configuration.

General updates

  • Updated the main README and contributing documentation.
  • Updated testing instructions.
  • Removed references to obsolete files and workflows.
  • Updated documentation to match the current Tauri and Vue application setup.

Motivation

The existing documentation no longer fully represented the current behavior and structure of the application. These changes make it easier for users, contributors, and deployment administrators to understand and work with the latest version of Cartographer App.

How to test

  1. Install the project dependencies:

    npm install

  2. Start the documentation development server:

    npm run docs:dev

  3. Open the URL printed in the terminal.

  4. Verify that:

    • All sidebar and navigation links work.
    • User documentation pages render correctly.
    • Technical component pages are accessible.
    • No broken links or missing assets are present.
    • Installation and deployment instructions match the current project setup.
  5. Build the documentation:

    npm run docs:build

Checklist

  • User documentation has been updated.
  • Technical documentation has been updated.
  • VuePress navigation has been updated.
  • Installation and deployment instructions have been reviewed.
  • Authentication-related documentation has been updated.
  • Documentation development server has been tested locally.
  • Production documentation build completes successfully.
  • Links and images have been manually reviewed.

Additional notes

This PR includes conflict resolutions for the following documentation files:

  • docs/technical/LoadXMLModal.md
  • docs/user/UserInterface.md
  • docs/user/actions.md
  • docs/user/installation.md

The resolved versions are intended to preserve the relevant existing content while incorporating the latest application changes.

@hizclick hizclick linked an issue Aug 5, 2026 that may be closed by this pull request
@hizclick
hizclick merged commit 334b834 into main Aug 5, 2026
@hizclick
hizclick deleted the 106-feature-documentatioin branch August 5, 2026 09:10
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.

[Feature] Documentatioin

1 participant