Refresh README to professional template with full feature coverage#73
Conversation
Agent-Logs-Url: https://github.com/ThisIs-Developer/Markdown-Viewer/sessions/31c08c9f-8568-420e-8c30-3a7db9c6c8cb Co-authored-by: ThisIs-Developer <109382325+ThisIs-Developer@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Agent-Logs-Url: https://github.com/ThisIs-Developer/Markdown-Viewer/sessions/b08a4e87-065d-4dba-86ae-061a26ec9c52 Co-authored-by: ThisIs-Developer <109382325+ThisIs-Developer@users.noreply.github.com>
Deploying markdown-viewer with
|
| Latest commit: |
4d5a0a3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4773b953.markdown-viewer.pages.dev |
| Branch Preview URL: | https://copilot-update-readme-profes.markdown-viewer.pages.dev |
Deploying markdownviewer with
|
| Latest commit: |
4d5a0a3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://153371cc.markdownviewer.pages.dev |
| Branch Preview URL: | https://copilot-update-readme-profes.markdownviewer.pages.dev |
Agent-Logs-Url: https://github.com/ThisIs-Developer/Markdown-Viewer/sessions/047fc32f-9402-4e59-8078-751b25f53099 Co-authored-by: ThisIs-Developer <109382325+ThisIs-Developer@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the project’s public-facing documentation (README + GitHub wiki pages) to present a more professional, comprehensive feature set and to add explicit transparency notes about data storage, privacy, and network dependencies.
Changes:
- Expanded wiki documentation with new transparency/privacy/security sections across multiple pages.
- Added a new “Development Journey” wiki page and linked it from the wiki Home.
- Refreshed the root README with a fuller feature breakdown, new structure, and updated getting-started instructions.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| wiki/Usage-Guide.md | Adds “Data Storage & Privacy” section and updates navigation. |
| wiki/Markdown-Reference.md | Adds a “Security Notes” section describing sanitization/local processing. |
| wiki/Installation.md | Adds transparency notes about CDN/network dependencies and desktop offline behavior. |
| wiki/Home.md | Links the new Development Journey page and adds transparency/data-handling summary. |
| wiki/Features.md | Expands the Privacy & Security bullets with more detailed data/network notes. |
| wiki/FAQ.md | Adds FAQ entries for analytics/local storage/network requests and refines offline explanation. |
| wiki/Docker-Deployment.md | Adds a “Transparency & Security” section describing image contents and headers. |
| wiki/Development-Journey.md | New page documenting evolution and linking historical deployments. |
| wiki/Desktop-App.md | Clarifies desktop app CDN dependency/offline mode and adds offline steps. |
| wiki/Contributing.md | Adds “Security Reporting” guidance. |
| wiki/Configuration.md | Adds “Transparency & Data Flow” section explaining local storage/CDNs/share/github import. |
| README.md | Replaces the README with a more structured template and fuller feature coverage. |
Comments suppressed due to low confidence (1)
wiki/Usage-Guide.md:187
- This section says the Copy button copies rendered HTML, but the current implementation behind
copy-markdown-buttoncopies the editor’s Markdown text (and the Ctrl/Cmd+C shortcut triggers that same action). Please update this text to reflect what is actually copied, or adjust the app behavior if the intent is to copy rendered HTML.
## Copy to Clipboard
Click the **📋 Copy** button to copy the **rendered HTML** of the preview to the clipboard. You can then paste it into email clients, word processors, or any tool that accepts rich text.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| **Keyboard Shortcuts** | ||
| - `Ctrl/Cmd + S` → Export Markdown | ||
| - `Ctrl/Cmd + C` → Copy rendered HTML (when no text is selected) |
There was a problem hiding this comment.
The README shortcut Ctrl/Cmd + C → Copy rendered HTML doesn’t match current behavior: Ctrl/Cmd+C triggers the Copy button, which copies the Markdown text (when there’s no selection). Please align the shortcut description with the actual behavior, or update the implementation to copy rendered HTML.
| - `Ctrl/Cmd + C` → Copy rendered HTML (when no text is selected) | |
| - `Ctrl/Cmd + C` → Copy Markdown (when no text is selected) |
| 2. Run `node prepare.js` to copy the updated file into `desktop-app/resources/`. | ||
| 3. Rebuild the app with `npm run build` or `npm run build:portable`. |
There was a problem hiding this comment.
These offline steps assume you run node prepare.js / npm run build from within the desktop-app/ directory; from the repo root those commands won’t work. Please make the working directory explicit (e.g., add a cd desktop-app step) or use root-invocable commands like node desktop-app/prepare.js and npm --prefix desktop-app run build.
| 2. Run `node prepare.js` to copy the updated file into `desktop-app/resources/`. | |
| 3. Rebuild the app with `npm run build` or `npm run build:portable`. | |
| 2. Change into the desktop app directory with `cd desktop-app`. | |
| 3. Run `node prepare.js` to copy the updated file into `desktop-app/resources/`. | |
| 4. Rebuild the app with `npm run build` or `npm run build:portable`. |
|
|
||
| Markdown Viewer is also available as a cross-platform native desktop application powered by [Neutralinojs](https://neutralino.js.org/). | ||
|
|
||
| > **Transparency note**: The desktop app uses the same `index.html` and CDN-hosted libraries as the web app. It can run offline after assets are cached, or if you replace CDN links with local copies and run `node prepare.js`. |
There was a problem hiding this comment.
This note says to run node prepare.js, but prepare.js lives under desktop-app/ and is intended to be run from that directory. Please clarify the exact command (cd desktop-app && node prepare.js) or provide the full path (node desktop-app/prepare.js) so users don’t try running it from the repo root.
| > **Transparency note**: The desktop app uses the same `index.html` and CDN-hosted libraries as the web app. It can run offline after assets are cached, or if you replace CDN links with local copies and run `node prepare.js`. | |
| > **Transparency note**: The desktop app uses the same `index.html` and CDN-hosted libraries as the web app. It can run offline after assets are cached, or if you replace CDN links with local copies and run `cd desktop-app && node prepare.js`. |
| - **Autosave**: Your content and tab state are stored in your browser’s `localStorage`. | ||
| - **Preferences**: Theme, view mode, and sync scroll settings are saved locally. | ||
| - **Clearing data**: Use your browser’s site data controls to remove saved content. | ||
| - **GitHub import**: Imports access public GitHub URLs via `api.github.com` and `raw.githubusercontent.com`. | ||
| - **Share links**: Shared URLs embed content in the hash portion of the URL; avoid sharing sensitive content. |
There was a problem hiding this comment.
Minor doc mismatch to fix while touching this page: the Share section earlier on the page describes the hash fragment as #content=…, but the implementation uses #share=. Updating that description will prevent confusion when users try to manually recognize/modify share URLs.
| ## Transparency & Network Dependencies | ||
|
|
||
| Markdown Viewer is a static client-side application, so there is no server-side processing or telemetry. However, the web build loads third-party libraries from public CDNs (cdnjs and jsDelivr) and GitHub imports use public GitHub APIs. If you require a fully offline or isolated environment, self-host the CDN assets and avoid GitHub import. | ||
|
|
||
| The Docker image contains only static assets and an Nginx server. There are no background services, analytics scripts, or external callbacks beyond the CDN libraries referenced by the app. |
There was a problem hiding this comment.
This new “Transparency & Network Dependencies” section isn’t linked from the Installation page’s Table of Contents at the top. Since this is a new top-level heading, add it to the TOC so readers can discover it quickly.
| Markdown Viewer is designed to be transparent about how your data is handled: | ||
|
|
||
| - **Local-only processing**: Markdown rendering happens entirely in your browser. | ||
| - **Local storage**: Content and preferences are saved in your browser's `localStorage` for autosave and session restore. |
There was a problem hiding this comment.
On this wiki Home page, the “Feature Highlights” list earlier says the Copy feature copies rendered HTML, but the current Copy action copies the raw Markdown from the editor. Please update that highlight (and any related wording) so the wiki matches actual clipboard behavior.
| - **Local storage**: Content and preferences are saved in your browser's `localStorage` for autosave and session restore. | |
| - **Local storage**: Content and preferences are saved in your browser's `localStorage` for autosave and session restore. | |
| - **Clipboard behavior**: The Copy action copies the raw Markdown from the editor to your clipboard; it does not copy rendered HTML from the preview. |
| - Import from local files, drag & drop, or public GitHub URLs (multi-file selection) | ||
| - Export as Markdown, HTML (standalone), or PDF | ||
| - Share documents via URL with compressed content | ||
| - Copy rendered HTML directly to clipboard |
There was a problem hiding this comment.
The Features list claims the app can “Copy rendered HTML directly to clipboard”, but the Copy action currently copies the raw Markdown from the editor. Either update this bullet to say it copies Markdown, or change the Copy behavior to copy rendered HTML.
| - Copy rendered HTML directly to clipboard | |
| - Copy Markdown directly to clipboard |
Uh oh!
There was an error while loading. Please reload this page.