-
Notifications
You must be signed in to change notification settings - Fork 580
#readme.md #729
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
#readme.md #729
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,65 +1,311 @@ | ||||||
| # PictoPy | ||||||
| <div align="center"> | ||||||
|
|
||||||
| PictoPy is an advanced desktop gallery application that combines the power of Tauri, React, and Rust for the frontend with a Python backend for sophisticated image analysis and management. | ||||||
| # 📸 PictoPy | ||||||
|
|
||||||
| # Want to Contribute? 😄 | ||||||
| **Your Intelligent Photo Gallery - Powered by AI, Protected by Privacy** | ||||||
|
|
||||||
| <a href="https://discord.gg/hjUhu33uAn"><img src="https://github.com/user-attachments/assets/3ed93273-5055-4532-a524-87a337a4fbba" height="40"></a> | ||||||
| [](LICENSE) | ||||||
| [](https://discord.gg/hjUhu33uAn) | ||||||
|
||||||
| [](https://discord.gg/hjUhu33uAn) | |
| [](https://discord.gg/hjUhu33uAn) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Read README.md to verify placeholder values at specified line ranges
wc -l README.mdRepository: AOSSIE-Org/PictoPy
Length of output: 75
🏁 Script executed:
#!/bin/bash
# Check lines 7-14 (already provided in snippet), then check other ranges
echo "=== Lines 126-141 (clone URL area) ==="
sed -n '126,141p' README.md
echo -e "\n=== Lines 211-228 (docs link area) ==="
sed -n '211,228p' README.md
echo -e "\n=== Lines 256-263 (contributors area) ==="
sed -n '256,263p' README.md
echo -e "\n=== Lines 287-299 (contact area) ==="
sed -n '287,299p' README.md
echo -e "\n=== Lines 308-309 (footer) ==="
sed -n '308,309p' README.mdRepository: AOSSIE-Org/PictoPy
Length of output: 1943
Replace placeholder URLs/IDs before merge (badges, clone URL, docs, issue tracker, contributors, contact).
Multiple instances of yourusername and placeholder values will break user onboarding and misdirect contributors.
-[](https://discord.gg/hjUhu33uAn)
+[](https://discord.gg/hjUhu33uAn)
-git clone https://github.com/yourusername/PictoPy.git
+git clone https://github.com/AOSSIE-Org/PictoPy.git
-- 📖 [Full Documentation](https://yourusername.github.io/PictoPy)
+- 📖 [Full Documentation](https://<REAL_DOCS_SITE>)
-- Thanks to all our [contributors](https://github.com/yourusername/PictoPy/graphs/contributors)
+- Thanks to all our [contributors](https://github.com/AOSSIE-Org/PictoPy/graphs/contributors)
-- 🐛 [Issue Tracker](https://github.com/yourusername/PictoPy/issues)
+- 🐛 [Issue Tracker](https://github.com/AOSSIE-Org/PictoPy/issues)
-- 📧 [Contact Us](mailto:contact@pictopy.dev)
+- 📧 [Contact Us](mailto:<REAL_CONTACT_EMAIL>)Also appears at lines 128, 213, and 308–309 in contribution/footer sections.
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
14-14: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In README.md around lines 7 to 14 (and also check occurrences at lines 128, 213,
and 308–309), there are placeholder URLs and IDs (e.g., your-discord-id,
yourusername, placeholder clone URL, docs, issue tracker, contributors, contact)
that must be replaced before merging; search the file for all placeholder tokens
and replace them with the project's real values (actual Discord server ID or
invite link, repository clone URL, real docs and issue tracker links,
license/author/contributor contacts, correct badge image links), verify each
replacement resolves and points to the live resource, and run a quick link-check
to ensure no remaining placeholders remain anywhere in the README.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
# First, find and read the README.md file
find . -name "README.md" -type f | head -5Repository: AOSSIE-Org/PictoPy
Length of output: 197
🏁 Script executed:
# Get the full README.md content with line numbers to examine the specific lines mentioned
wc -l README.mdRepository: AOSSIE-Org/PictoPy
Length of output: 75
🏁 Script executed:
# Read the README.md file to see the structure and the flagged lines
head -70 README.md | cat -nRepository: AOSSIE-Org/PictoPy
Length of output: 3736
🏁 Script executed:
# Read lines around the flagged sections
sed -n '10,25p' README.md | cat -n
sed -n '32,40p' README.md | cat -n
sed -n '60,70p' README.md | cat -n
sed -n '110,120p' README.md | cat -n
sed -n '194,202p' README.md | cat -n
sed -n '251,260p' README.md | cat -nRepository: AOSSIE-Org/PictoPy
Length of output: 2592
🌐 Web query:
GitHub markdown heading ID generation emojis anchor links
💡 Result:
Short answer — GitHub (and tools that emulate it) create heading IDs by "slugifying" the heading text: convert to lower‑case, strip formatting/punctuation/unsupported characters, replace spaces with hyphens, and make duplicates unique by appending -1, -2, etc. GitHub-style slugs are produced by the github-slugger algorithm; it also removes emoji characters (which can leave a leading hyphen if the emoji was at the start). [1][2]
Notes / examples:
- "My Heading" → "my-heading". [2]
- Duplicate headings get suffixes: "foo" → "foo", next "foo" → "foo-1". [2]
- Emoji handling: "😄 emoji" → "-emoji" (the emoji is removed). [2]
- GitHub docs summarize the rules: lower-case, spaces→hyphens, punctuation removed, markup stripped, uniqueness via -1, -2. [1]
If you need exact behavior for a specific renderer (GitHub.com, Enterprise, a static site generator, or a library), tell me which one and I’ll show the exact slug output and/or code you can reuse.
Sources:
[1] GitHub Docs — Basic writing and formatting syntax (automatic anchor rules).
[2] github-slugger (README / examples).
🌐 Web query:
GitHub heading fragment identifier emoji behavior
💡 Result:
Short answer: GitHub’s auto-generated heading anchors use the same slugification rules as the open-source github-slugger algorithm — emoji characters are removed (not preserved as emoji), so they can produce unexpected hyphens or empty segments in the slug. Example: the slugger maps "😄 emoji" → "-emoji". Use plain text, move or remove emoji, or set an explicit id to control the fragment. [1][2]
Sources:
- GitHub docs: rules used to generate section links (lowercase, spaces→hyphens, remove punctuation/formatting). [1]
- github-slugger (implementation and examples showing emoji handling, e.g. '😄 emoji' → '-emoji'). [2]
🌐 Web query:
GitHub heading anchor "#-features" emoji prefix hyphen works
💡 Result:
Short answer: It’s not reliable. GitHub’s slug rules remove punctuation and whitespace and lower-case text, but emoji handling is inconsistent across renderers — sometimes the emoji is stripped and you get a slug like "#-features" or "#features", sometimes the emoji (or its name) ends up in the slug. Test in your repo or, for a stable result, add an explicit anchor (e.g. or use heading {#features}). [1][2][3]
Sources:
- GitHub Docs — rules used to generate heading anchors (punctuation removed, spaces → hyphens). [1]
- github-slugger / markdown tooling that emulates GitHub slug rules. [2]
- Reports/discussion showing inconsistent emoji behavior in headings/anchors. [3]
🌐 Web query:
GitHub markdown explicit anchor id HTML <a> tags fragment links
💡 Result:
Short answer
- GitHub automatically generates anchors for headings; link with text. [1][4]
- If you need an explicit anchor ID, add an HTML anchor before the heading: or then link to it with link. This works in README/markdown on github.com. [5][1]
- Note: GitHub sanitizes HTML and may rewrite or prefix IDs (e.g. user-content-...) or strip some attributes, so prefer the heading-slug or test the rendered page to confirm the exact fragment. [6][2]
Examples
- Heading auto-anchor:
- Markdown: ## My Cool Heading
- Link: Go. [1][4]
- Explicit HTML anchor:
- Markdown:
Section title
- Link: Jump. [5][1]
- Markdown:
Sources
[1] GitHub Docs — Basic writing and formatting syntax (section links).
[2] GitHub community / markup discussion — HTML sanitization (IDs/classes may be affected).
[4] GitHub Flavored Markdown spec — fragment identifiers in links.
[5] Community examples/gists showing before headings.
🌐 Web query:
GitHub markdown heading attributes {#custom-id} syntax
💡 Result:
Short answer: GitHub.com (GFM) does not support Pandoc-/kramdown-style inline heading attributes like {#custom-id}. GitHub automatically generates anchor IDs for headings (you can link with #generated-id), but the {#id} attribute syntax is not part of the GFM spec. If you build a site with GitHub Pages using Jekyll/kramdown (or use a Markdown processor/plugin that supports it) you can add custom IDs via that processor’s attribute syntax (kramdown/Pandoc/markdown-it-attrs), or by writing raw HTML. (github.github.io)
Examples / options
- GFM (github.com): rely on auto-generated heading IDs (no {#id} support). (github.github.io)
- GitHub Pages with kramdown/Jekyll: enable kramdown and use its attribute/IAL syntax (processor-specific) to set IDs. (docs.github.com)
- Other processors/plugins (Pandoc, markdown-it + markdown-it-attrs/markdown-it-anchor): support #id syntax (e.g. # Heading {#my-id}). (github.com)
If you tell me where you’re rendering the Markdown (github.com README, GitHub Pages, a static site generator, or a particular tool), I’ll give the exact syntax that will work there.
Citations:
- 1: https://github.github.io/gfm/?utm_source=openai
- 2: https://github.github.io/gfm/?utm_source=openai
- 3: https://docs.github.com/articles/updating-your-markdown-processor-to-kramdown?utm_source=openai
- 4: https://github.com/valeriangalliat/markdown-it-anchor?utm_source=openai
Use explicit HTML anchors to replace emoji-dependent heading IDs for reliable section links.
The current anchor links (#-features, etc.) rely on GitHub's emoji stripping behavior, which is inconsistent across renderers. While <a name="id"></a> anchors are supported on GitHub.com, note that GitHub may sanitize and prefix IDs with user-content-, so test the rendered page to confirm the exact fragment identifiers work.
-[Features](#-features) • [Screenshots](#-screenshots) • [Getting Started](#-getting-started) • [Contributing](#-contributing) • [Documentation](#-documentation)
+<a name="features"></a>
+<a name="screenshots"></a>
+<a name="getting-started"></a>
+<a name="contributing"></a>
+<a name="documentation"></a>
+
+[Features](#features) • [Screenshots](#screenshots) • [Getting Started](#getting-started) • [Contributing](#contributing) • [Documentation](#documentation)Also applies to: 35-36, 63-64, 113-114, 197-198, 254-256
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
14-14: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
In README.md around lines 14-16 (also apply same change at 35-36, 63-64,
113-114, 197-198, 254-256), replace the emoji-dependent fragment links (e.g.
#‑features) by adding explicit HTML anchor elements with stable IDs immediately
before the corresponding section headings (for example: <a name="features"></a>
before the Features heading) and update the navigation links to point to those
stable IDs; after changes, test the rendered README on GitHub to verify the
final fragment identifiers (note GitHub may prefix with user-content- in some
contexts) and adjust anchor names if needed so links work reliably across
renderers.
Copilot
AI
Dec 13, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The heading mentions "Windows & Ubuntu/Debian" but the script instructions below cover "Windows (PowerShell)" and "Linux/macOS". The heading should be updated to match the actual platforms covered, such as "Windows, Linux & macOS" or simply removed since the script instructions below already specify the platforms.
| **Windows & Ubuntu/Debian:** | |
| **Windows, Linux & macOS:** |
Copilot
AI
Dec 13, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The URL contains a placeholder 'yourusername' that needs to be replaced with the actual GitHub username or organization name for the repository.
| git clone https://github.com/yourusername/PictoPy.git | |
| git clone https://github.com/PictoPy/PictoPy.git |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a language tag to the fenced block (markdownlint MD040) and consider text for the ASCII diagram.
-```
+```text
┌─────────────────────────────────────────────────────────────┐
...
└────────────────────────────────────────────────────────────┘
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
166-166: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In README.md around lines 166 to 193 the fenced code block containing the ASCII
diagram lacks a language tag (violates markdownlint MD040); update the opening
fence to include a language tag (use "text") so it becomes ```text and ensure
the closing fence remains ``` so the block is a proper fenced code block with
the language specified.
Copilot
AI
Dec 13, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The URL contains a placeholder 'yourusername' that needs to be replaced with the actual GitHub username or organization name for the repository.
| git clone https://github.com/yourusername/PictoPy.git | |
| git clone https://github.com/<your-github-org-or-username>/PictoPy.git |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix malformed documentation URL (line break in middle of URL).
The documentation URL is broken across lines and incomplete. Provide the correct, continuous URL.
-- 📖 [Full Documentation](https://AOSSIE-Org
-PictoPy.github.io/PictoPy)
+- 📖 [Full Documentation](https://<ACTUAL_DOCS_SITE>)🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
256-256: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In README.md around lines 256 to 257, the documentation link is broken by a line
break inside the URL; replace the broken split text with a single continuous,
correct URL (for example: https://AOSSIE-Org/PictoPy.github.io/PictoPy) so the
markdown link renders and navigates correctly.
Copilot
AI
Dec 13, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The contributors URL contains a placeholder 'yourusername' that needs to be replaced with the actual GitHub username or organization name for the repository.
Copilot
AI
Dec 13, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The website link includes a placeholder domain 'pictopy.dev' with "(if available)" note. If this website doesn't exist, this link should be removed or the line should be commented out to avoid broken links.
| - 🌐 [Website](https://pictopy.dev) (if available) |
Copilot
AI
Dec 13, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The issue tracker URL contains a placeholder 'yourusername' that needs to be replaced with the actual GitHub username or organization name for the repository.
Copilot
AI
Dec 13, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The contact email 'contact@pictopy.dev' appears to be a placeholder. If this email address is not active, this link should be removed or replaced with a valid contact method.
| - 📧 [Contact Us](mailto:contact@pictopy.dev) |
Copilot
AI
Dec 13, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The bug report and feature request URLs contain a placeholder 'yourusername' that needs to be replaced with the actual GitHub username or organization name for the repository.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid bold “taglines” that act like headings (markdownlint MD036); use an actual heading level.
Also applies to: 304-307
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
5-5: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents