Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the OpenQDA user documentation for the 1.0.6 release by fixing wording issues, adding documentation for Notes usage, and updating/adding screenshots that reflect the current UI.
Changes:
- Add new documentation pages/sections describing Notes (for Sources, Codes, and Selections) with updated screenshots.
- Fix typos/grammar and improve wording across multiple workflow and project docs.
- Update build artifacts/config related to the docs site (lockfile changes; VitePress sidebar link addition).
Reviewed changes
Copilot reviewed 24 out of 40 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| package-lock.json | Updates transitive dependencies used by the docs build (e.g., rollup/vite). |
| docs/workflow/publications.md | Fix capitalization/grammar in DOI section. |
| docs/workflow/preparation/states.md | Fix page title and wording for available actions. |
| docs/workflow/preparation/notes.md | New Notes documentation for Sources with screenshots. |
| docs/workflow/preparation/manage_sources.md | Grammar fixes and clarifies unlock behavior. |
| docs/workflow/preparation/add_sources.md | Grammar/wording fixes in import flow. |
| docs/workflow/coding/sorting.md | Fix duplicated “now” wording. |
| docs/workflow/coding/selections.md | Fix “section”→“selection” terminology and add Selection Notes documentation + screenshots. |
| docs/workflow/coding/overview.md | Fix typos, improve wording, and reference Notes management docs. |
| docs/workflow/coding/codes.md | Fix typo and add Code Notes documentation + screenshots. |
| docs/workflow/analysis/overview.md | Grammar fix in code portrait description. |
| docs/ui.md | Improve wording for desktop/mobile UI behavior and mobile menu description. |
| docs/registration.md | Update screenshot path for verification step. |
| docs/refi.md | Fix capitalization of OpenQDA in terminology section. |
| docs/public/img/preparation/notes_sources_panel.png | Add/update screenshot for opening source notes panel. |
| docs/public/img/preparation/notes_sources_edit.png | Add/update screenshot for editing source notes. |
| docs/public/img/preparation/notes_sources_delete.png | Add/update screenshot for deleting source notes. |
| docs/public/img/preparation/notes_file_list.png | Add/update screenshot for notes icon in source list. |
| docs/public/img/coding/notes_selection_list.png | Add screenshot for notes shown in selection list. |
| docs/public/img/coding/notes_selection_editor.png | Add screenshot for notes indicator in editor. |
| docs/public/img/coding/notes_codes_overview.png | Add screenshot for notes shown in codes overview. |
| docs/projects/teams.md | Fix grammar about access after team deletion. |
| docs/projects/manage.md | Improve wording, fix typos (“its”, “Overview”), and clarify “users icon”/team wording. |
| docs/projects/history.md | Grammar fix (“provides”). |
| docs/projects/codebooks.md | Grammar fix, correct link to coding overview, and wording fix in upload section. |
| docs/privacy.md | Improve phrasing for privacy policy sentence. |
| docs/index.md | Improve feature description wording/punctuation. |
| docs/disclaimer.md | Improve legal wording and fix “any time(s)” grammar. |
| docs/about.md | Fix “publish you data” → “publish your data”. |
| docs/.vitepress/config.mts | Add sidebar link for the new Notes page in preparation workflow. |
| docs/.vitepress/cache/deps/_metadata.json | VitePress/Vite cache metadata updated (generated artifact). |
| docs/.vitepress/cache/deps/@theme_index.js | VitePress/Vite cache JS artifact with absolute local paths (generated artifact). |
| .gitignore | Ignore docs/.vitepress/cache/. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This updates the docs for Release 1.0.6.