Skip to content

docs: הוספת מדריך מימוש תצוגת Markdown בדפדפן הריפו - #3011

Open
amirbiron wants to merge 2 commits into
mainfrom
claude/markdown-preview-toggle-dcdDL
Open

docs: הוספת מדריך מימוש תצוגת Markdown בדפדפן הריפו#3011
amirbiron wants to merge 2 commits into
mainfrom
claude/markdown-preview-toggle-dcdDL

Conversation

@amirbiron

@amirbiron amirbiron commented Jan 30, 2026

Copy link
Copy Markdown
Owner

✨ תיאור קצר

הוספת מדריך תיעוד מפורט למימוש תכונת תצוגת Markdown מעוצבת לקבצי .md בדפדפן הריפו (Repo Browser). המדריך כולל הנחיות שלב-אחר-שלב, דוגמאות קוד, CSS, וטיפים לשיפורים אופציונליים.

📦 שינויים עיקריים

  • תיעוד (docs/)

פירוט:

  • הוספת קובץ docs/guides/markdown-preview-repo-browser.md (730 שורות)
  • מדריך מלא בעברית המכסה:
    • סקירת הארכיטקטורה הקיימת
    • 5 שלבי מימוש מפורטים (HTML, CSS, JavaScript)
    • דוגמאות קוד מלאות וממוקדות
    • שיפורים אופציונליים (Split View, TOC צף, וכו')
    • Checklist בדיקות ידניות
    • סיכום וזמן משוער למימוש

🧪 בדיקות

  • Manual: בדיקת קריאות המדריך, בדיקת דוגמאות הקוד לתקינות תחבירית
  • Verification: וידוא שכל הקבצים המוזכרים קיימים בפרויקט
  • Consistency: בדיקת עקביות עם קוד הפרויקט הקיים

בדיקות שלא נדרשות:

  • Unit Tests: לא רלוונטי (תיעוד בלבד)
  • Integration Tests: לא רלוונטי (תיעוד בלבד)

📝 סוג שינוי

  • docs: שינוי תיעוד בלבד

✅ צ'קליסט

  • הקוד עוקב אחרי הסגנון (תיעוד בעברית, עקבי עם סגנון הפרויקט)
  • תיעוד עודכן (הוספת מדריך חדש)
  • אין סודות/מפתחות בקוד
  • אין מחיקות מסוכנות
  • הודעת הקומיט תואמת Conventional Commits
  • כל ה-Required Checks ירוקים (תיעוד בלבד)

🧩 השפעות/סיכונים

  • השפעה: אין - זהו קובץ תיעוד בלבד, לא משפיע על קוד הפרודקשן
  • סיכון: אפס - תיעוד בלבד
  • Rollback: לא נדרש

🔗 קישורים

  • מדריך זה מתייחס לתכונה שעדיין לא מומשה בקוד
  • יכול לשמש כבסיס למימוש בעתיד

📝 הערות נוספות

מדריך זה מספק:

  1. הבנה מלאה של הארכיטקטורה הקיימת
    2

https://claude.ai/code/session_01XnUcUcErgTNrT54tzTBh4a


Note

Low Risk
Documentation-only change that doesn’t modify runtime code; risk is limited to potential future implementation guidance inaccuracies.

Overview
Adds a new Hebrew guide, docs/guides/markdown-preview-repo-browser.md, that documents a step-by-step implementation plan for a Markdown preview toggle in the Repo Browser.

The guide covers required UI markup and styling changes, JavaScript state/toggle logic (including selectFile integration, localStorage preference, and a Ctrl+Shift+M shortcut), and required asset-loading order for markdown-enhanced.css and live-preview.js, plus optional enhancements and a manual test checklist.

Written by Cursor Bugbot for commit 480f0df. This will update automatically on new commits. Configure here.

Detailed Hebrew guide for implementing a Markdown preview toggle feature
in the repo browser, including:
- Architecture overview of existing code
- Step-by-step implementation instructions
- HTML, CSS, and JavaScript code examples
- Integration with existing MarkdownLiveRenderer
- Optional enhancements (split view, TOC, etc.)
- Testing checklist

https://claude.ai/code/session_01XnUcUcErgTNrT54tzTBh4a
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@github-actions

github-actions Bot commented Jan 30, 2026

Copy link
Copy Markdown

🧯 Dangerous deletes guard report

Policy: see .cursorrules — dangerous deletions are blocked unless wrapped safely.

Summary:

  • Flagged findings (blocking): 0
    0
  • Excluded matches (not blocking): 15
  • Total matches (all files): 125

Flagged findings (file:line:snippet):
(none)

Excluded matches (by path pattern)
./Dockerfile:42:    rm -rf /var/lib/apt/lists/*
./Dockerfile:121:    rm -rf /var/lib/apt/lists/*
./webapp/static/js/md_preview.bundle.js.map:4:  "sourcesContent": ["// Markdown-it plugin to render GitHub-style task lists; see\n//\n// https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments\n// https://github.com/blog/1825-t … [truncated]
./README.md:842:find . -name "__pycache__" -exec rm -rf {} +
./docs/DOCUMENTATION_GUIDE.md:453:rm -rf _build
./docs/Makefile:24:	rm -rf $(BUILDDIR)
./node_modules/mermaid/dist/chunks/mermaid.core/chunk-KS23V3DP.mjs.map:4:  "sourcesContent": ["{\n  \"name\": \"mermaid\",\n  \"version\": \"11.12.0\",\n  \"description\": \"Markdown-ish syntax for generating flowcharts, mindmaps, sequence  … [truncated]
./node_modules/mermaid/dist/chunks/mermaid.esm.min/chunk-4HFYJGYH.mjs.map:4:  "sourcesContent": ["{\n  \"name\": \"mermaid\",\n  \"version\": \"11.12.0\",\n  \"description\": \"Markdown-ish syntax for generating flowcharts, mindmaps, sequen … [truncated]
./node_modules/mermaid/dist/chunks/mermaid.esm.min/chunk-4HFYJGYH.mjs:1:var r={name:"mermaid",version:"11.12.0",description:"Markdown-ish syntax for generating flowcharts, mindmaps, sequence diagrams, class diagrams, gantt charts, git graph … [truncated]
./node_modules/mermaid/dist/chunks/mermaid.esm/chunk-2M32CCKP.mjs.map:4:  "sourcesContent": ["{\n  \"name\": \"mermaid\",\n  \"version\": \"11.12.0\",\n  \"description\": \"Markdown-ish syntax for generating flowcharts, mindmaps, sequence d … [truncated]
./node_modules/mermaid/dist/mermaid.min.js:1524:`,"getStyles"),c1e=RQe});var h1e={};dr(h1e,{diagram:()=>NQe});var NQe,f1e=N(()=>{"use strict";$ge();a1e();l1e();u1e();NQe={parser:Fge,db:n1e,renderer:o1e,styles:c1e}});var m1e,g1e=N(()=>{"use  … [truncated]
./node_modules/mermaid/dist/mermaid.js.map:4:  "sourcesContent": ["/**\n* Default values for dimensions\n*/\nconst defaultIconDimensions = Object.freeze({\n\tleft: 0,\n\ttop: 0,\n\twidth: 16,\n\theight: 16\n});\n/**\n* Default values for tr … [truncated]
./node_modules/mermaid/dist/mermaid.min.js.map:4:  "sourcesContent": ["/**\n* Default values for dimensions\n*/\nconst defaultIconDimensions = Object.freeze({\n\tleft: 0,\n\ttop: 0,\n\twidth: 16,\n\theight: 16\n});\n/**\n* Default values fo … [truncated]
./node_modules/katex/package.json:153:    "build": "rimraf dist/ && mkdirp dist && cp README.md dist && rollup -c --failAfterWarnings && webpack && node update-sri.js package dist/README.md",
./node_modules/katex/src/fonts/Makefile:139:	rm -rf pfa ff otf ttf woff woff2

@github-actions

github-actions Bot commented Jan 30, 2026

Copy link
Copy Markdown

⏱️ Performance report

(No performance test durations collected. Mark tests with @pytest.mark.performance.)

@github-actions

Copy link
Copy Markdown

📖 Documentation Preview

The documentation has been built successfully!

To view locally:

  1. Download the artifacts
  2. Extract the zip file
  3. Open index.html in your browser

@sentry

sentry Bot commented Jan 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants