Dev lanari 1 by lanari · Pull Request #10 · xmaptools/Documentation

lanari · 2026-02-09T07:48:15Z

version 1.2

Copilot

Pull request overview

Updates the VitePress-based XMapTools documentation site for “version 1.2”, including new getting-started/installation content, refreshed navigation, and migration of many embedded images to the external Documentation_Images repository.

Changes:

Add new “Getting started” pages and a detailed macOS/Windows installation & update guide.
Restructure site navigation (nav + sidebar) and refresh the home page links/images.
Update project metadata (version bump, script change, license change) and expand contributor documentation in README.md.

Reviewed changes

Copilot reviewed 16 out of 52 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
videos.md	Adds a new “Videos” landing page stub.
tutorials.md	Switches many images/icons to `Documentation_Images` raw URLs; some doc text/formatting issues introduced.
package.json	Bumps version to 1.2.0, changes `dev` script, updates author/license.
installation_guide.md	New detailed installation/update guide for macOS and Windows.
index.md	Updates homepage CTA links and replaces some images with external `<img>` tags.
getting-started.md	New intro + compatibility matrix; links into installation guide.
getting-started-2.md	New “first launch” guide and common questions.
documentation.md	Removes the old placeholder documentation page.
doc-laicpms.md	Adds initial LA-ICP-MS documentation page/content.
doc-epma.md	Adds extensive EPMA documentation page/content.
README.md	Replaces minimal README with full contributor/setup guidance.
.vitepress/config.js	Updates logo location and significantly expands nav/sidebar structure.
.vitepress/cache/deps/*	Adds VitePress cache artifacts (should not be committed).
.gitignore	Adds duplicate `.DS_Store` entries; still doesn’t ignore root `.vitepress/cache`.
.github/workflows/vitepress.yml	Removes the step that copied `assets/*` into `.vitepress/public`.
.DS_Store	Adds an OS-generated file (should not be committed).

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

README.md

tutorials.md

getting-started.md

package.json

.vitepress/cache/deps/_metadata.json

index.md

tutorials.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot · 2026-02-09T07:58:10Z

@lanari I've opened a new pull request, #11, to work on those changes. Once the pull request is ready, I'll request review from you.

lanari · 2026-02-09T07:58:19Z

@copilot open a new pull request to apply changes based on the comments in this thread

Copilot · 2026-02-09T07:58:27Z

@lanari I've opened a new pull request, #12, to work on those changes. Once the pull request is ready, I'll request review from you.

* Initial plan * Fix typo: change 'figure bellow' to 'figure below' in tutorials.md Co-authored-by: lanari <54409312+lanari@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: lanari <54409312+lanari@users.noreply.github.com>

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 16 out of 52 changed files in this pull request and generated 9 comments.

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

Copilot · 2026-02-09T08:08:12Z

getting-started-2.md

+
+## I am lost, where can I get some help?
+
+You can find articles on this website and help files in the program. We also have [tutorial videos](/tutorials.html). Do not hesitate to click on the help button available in each section to access a description of the main steps. If you feel that something is missing or unclear, or if you find an error, do not hesitate to contact us on [Discord](https://discord.com/invite/2ak9RXcJ5b) or via the [developer repository](https://github.com/xmaptools/XMapTools_Developers) on GitHub.


This page links to /tutorials.html, which is unlikely to exist in the VitePress build. Use the /tutorials route instead.

Copilot · 2026-02-09T08:08:13Z

doc-epma.md

@@ -0,0 +1,450 @@
+# XMapTools documentation for EPMA
+
+## Table of content


Section title should be plural: “Table of content” → “Table of contents”.

Copilot · 2026-02-09T08:08:13Z

package.json

+  "author": "XMapTools",
+  "license": "GNU General Public License v3.0"


The package metadata now declares the project under GPLv3, but there is no LICENSE file in the repo. To avoid ambiguity for downstream users, add a LICENSE file containing the GPLv3 text (or the chosen license) and ensure it matches the README/package.json.

Copilot · 2026-02-09T08:08:13Z

.vitepress/cache/deps/vue.js

+import {
+  BaseTransition,
+  BaseTransitionPropsValidators,
+  Comment,
+  DeprecationTypes,


The .vitepress/cache/deps output is generated by Vite/VitePress dependency optimization and shouldn’t be committed. Remove this file (and the rest of .vitepress/cache/) from the repo and add .vitepress/cache/ to .gitignore to avoid huge diffs and merge conflicts.

Copilot · 2026-02-09T08:08:13Z

index.md

+      text: Installation
+      link: /installation_guide


The home page hero image is still set to /assets/Logo_2025_square_512.Xsq7Ybeo.png, but this repo no longer contains an assets/ directory and the Pages workflow no longer copies assets into the build output. Update hero.image.src to a valid URL (e.g., the Documentation_Images raw URL) or reintroduce an assets publishing step.

Copilot · 2026-02-09T08:08:14Z

doc-epma.md

+- JEOL (SUN) requires two files for each map: 'XX.cnd' and 'XX_map.txt', and two files for each set of spot analyses: 'summary.txt' and 'stage.txt'.
+- CAMECA requires one file for each map: 'XXXX.txt', and a single file for each set of spot analyses: 'YYY.csv'.
+
+#### Step 2: Set the destimation folder


Typo in heading: “destimation” → “destination”.

Copilot · 2026-02-09T08:08:14Z

doc-laicpms.md

@@ -0,0 +1,103 @@
+# XMapTools documentation
+
+## Table of content


Section title should be plural: “Table of content” → “Table of contents”.

Copilot · 2026-02-09T08:08:14Z

.github/workflows/vitepress.yml

-          mkdir -p .vitepress/public
-          cp -R assets/* .vitepress/public/
-
      # Setup GitHub Pages


Since the workflow no longer copies a local assets/ directory into the published site, any remaining /assets/... references will break on Pages. There is at least one in index.md (hero.image.src); either update the docs to use the external Documentation_Images URLs everywhere or restore an assets publish step.

Copilot · 2026-02-09T08:08:15Z

getting-started-2.md

+- Working with **EPMA** data? Try this [tutorial](/tutorials.html#tutorial-1-xmaptools-for-epma-2023).
+- Working with **LA-ICP-MS** data? Read this [paper](https://pierrelanari.com/wp-content/uploads/2024/01/2024_Markmann_ChemGeol.pdf).


/tutorials.html#... looks like a legacy/static-site URL and is likely to 404 under VitePress’ default routing. Update this link to point to the VitePress route for the tutorials page (and the correct heading anchor).

lanari · 2026-02-09T08:09:56Z

@copilot open a new pull request to apply changes based on the comments in this thread

Copilot · 2026-02-09T08:10:04Z

@lanari I've opened a new pull request, #13, to work on those changes. Once the pull request is ready, I'll request review from you.

* Initial plan * Changes before error encountered Co-authored-by: lanari <54409312+lanari@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: lanari <54409312+lanari@users.noreply.github.com>

lanari added 5 commits October 7, 2025 08:31

update getting started

0ec052d

Update documentation.md

4114289

update repo

909e4ec

Update to 1.2

3caab46

minor update

fee744a

Copilot AI review requested due to automatic review settings February 9, 2026 07:48

Copilot started reviewing on behalf of lanari February 9, 2026 07:48 View session

Copilot AI reviewed Feb 9, 2026

View reviewed changes

Update README.md

988977d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI mentioned this pull request Feb 9, 2026

[WIP] WIP addressing feedback on Dev lanari 1 PR #11

Merged

3 tasks

Copilot AI mentioned this pull request Feb 9, 2026

[WIP] Update XMapTools documentation for version 1.2 #12

Merged

10 tasks

Copilot AI and others added 2 commits February 9, 2026 08:59

Initial plan (#12)

ebd0ccd

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

lanari requested a review from Copilot February 9, 2026 08:01

Copilot started reviewing on behalf of lanari February 9, 2026 08:01 View session

Copilot AI reviewed Feb 9, 2026

View reviewed changes

Copilot AI mentioned this pull request Feb 9, 2026

[WIP] Update VitePress documentation site for version 1.2 #13

Merged

10 tasks

lanari merged commit 2954518 into main Feb 9, 2026
2 checks passed


		## I am lost, where can I get some help?

		You can find articles on this website and help files in the program. We also have [tutorial videos](/tutorials.html). Do not hesitate to click on the help button available in each section to access a description of the main steps. If you feel that something is missing or unclear, or if you find an error, do not hesitate to contact us on [Discord](https://discord.com/invite/2ak9RXcJ5b) or via the [developer repository](https://github.com/xmaptools/XMapTools_Developers) on GitHub.

		@@ -0,0 +1,450 @@
		# XMapTools documentation for EPMA

		## Table of content

		"author": "XMapTools",
		"license": "GNU General Public License v3.0"

		@@ -0,0 +1,103 @@
		# XMapTools documentation

		## Table of content

		- Working with EPMA data? Try this [tutorial](/tutorials.html#tutorial-1-xmaptools-for-epma-2023).
		- Working with LA-ICP-MS data? Read this [paper](https://pierrelanari.com/wp-content/uploads/2024/01/2024_Markmann_ChemGeol.pdf).

Conversation

lanari commented Feb 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Feb 9, 2026

Uh oh!

lanari commented Feb 9, 2026

Uh oh!

Copilot AI commented Feb 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

lanari commented Feb 9, 2026

Uh oh!

Copilot AI commented Feb 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants