Skip to content

18 write the readme #60

Merged
merged 10 commits into from
Nov 10, 2025
Merged

18 write the readme #60

merged 10 commits into from
Nov 10, 2025

Conversation

kleinc
Copy link
Member

@kleinc kleinc commented Nov 10, 2025

Issue number

Closes 18

Description

Created the User Guide
Klein had to make the PR because of a bug, Alicia wrote the User Guide/ completed this issue

Testing steps

Does the User Guide show up
Check the links between the User Guide and README
Check that the screenshots show up

Screenshots (optional)

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive User Guide covering navigation, sidebar tools (elevation, filters, measurements, saved locations, appearance, tools, scene, about), minimap, coordinates, and image-backed instructions — a full end-to-end reference for users.
    • Added links to the new User Guide from the project README in two locations for easier discovery.

@kleinc kleinc linked an issue Nov 10, 2025 that may be closed by this pull request
@coderabbit
Copy link

coderabbit bot commented Nov 10, 2025

Walkthrough

Adds two "User Guide" links to README.md (with differing capitalization/paths) and introduces a new, detailed Userguide.md documenting Molloy Explorer UI, controls, tools, and workflows (documentation-only; no code or API changes).

Changes

Cohort / File(s) Change Summary
Documentation Links
README.md
Inserts two "User Guide" hyperlinks that reference Userguide.md in separate README sections (paths/capitalization differ).
User Guide File
Userguide.md
Adds a new comprehensive user guide covering fundamentals, sidebar items, minimap, coordinates, measurements, clipping, navigation/camera controls, appearance, scene management, tools, and illustrative images.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Documentation-only changes; no code or API surface affected
  • Quick checks recommended:
    • Confirm both README links point to the intended Userguide.md path and capitalization
    • Verify internal anchors and referenced images render and resolve correctly

Poem

🐇 I hopped through lines of docs so bright,

Found maps and knobs and steps by lantern light.
Zoom and clip and save each hidden trail,
A snug guide for explorers—soft and hale. ✨


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 9e16702 and c0af632.

📒 Files selected for processing (1)
  • Userguide.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Userguide.md

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

Comment @coderabbitai help to get the list of available commands and usage tips.

removed a note in text
Copy link
Member Author

@kleinc kleinc left a comment

Choose a reason for hiding this comment

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

Nice!

Suggestions:

  • Rename "Menu Bar" to "Side Bar"
  • Move the UserGuide foler to the root folder

Copy link
Member

@franmagn franmagn left a comment

Choose a reason for hiding this comment

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

Left some comments

@aliciawr aliciawr closed this Nov 10, 2025
@aliciawr aliciawr reopened this Nov 10, 2025
Copy link
Member

@adriahso adriahso left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@franmagn franmagn left a comment

Choose a reason for hiding this comment

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

LGTM!

@aliciawr aliciawr merged commit 274515e into dev Nov 10, 2025
3 checks passed
@aliciawr aliciawr deleted the 18-write-the-readme branch November 10, 2025 09:21
Sign in to join this conversation on GitHub.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write the Readme
4 participants