106 feature documentatioin - #171
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Technical documentation
AppHeaderAppFooterAppSidebarLoadXMLModalAuthentication and Git integration
Deployment
General updates
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
Install the project dependencies:
npm installStart the documentation development server:
npm run docs:devOpen the URL printed in the terminal.
Verify that:
Build the documentation:
npm run docs:buildChecklist
Additional notes
This PR includes conflict resolutions for the following documentation files:
docs/technical/LoadXMLModal.mddocs/user/UserInterface.mddocs/user/actions.mddocs/user/installation.mdThe resolved versions are intended to preserve the relevant existing content while incorporating the latest application changes.