Add PROJECTS_DASHBOARD.md and link from README with LaTeX-ready JSON#3
Add PROJECTS_DASHBOARD.md and link from README with LaTeX-ready JSON#3xerohour wants to merge 1 commit into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new PROJECTS_DASHBOARD.md file that provides a structured index of the repository's projects, featuring both a LaTeX-formatted JSON block and a human-readable markdown table. A corresponding link to this dashboard was added to the main README.md. Feedback was provided to resolve a contradiction regarding whether the index is auto-curated or manually maintained, fix a potential LaTeX compilation error in the JSON layout field, and ensure data parity between the JSON objects and the markdown table.
| @@ -0,0 +1,104 @@ | |||
| # 📚 Project Dashboard Table of Contents | |||
|
|
|||
| > Auto-curated project index from local `README.md` files in this repository. | |||
There was a problem hiding this comment.
The description mentions that the index is "Auto-curated," but the instructions at the end of the file (line 104) state that manual updates are required. To avoid misleading future maintainers, consider updating this to reflect that it is a manually maintained structured index.
| > Auto-curated project index from local `README.md` files in this repository. | |
| > Curated project index from local README.md files in this repository. |
| "style": { | ||
| "table_theme": "\\textcolor{green}{Matrix}", | ||
| "accent": "\\texttt{#00ff41}", | ||
| "layout": "\\mathrm{detailed}" |
There was a problem hiding this comment.
The \\mathrm LaTeX command is intended for math mode. If this JSON payload is injected into a standard LaTeX text block, it will cause a compilation error unless wrapped in delimiters. Using \\texttt would be more consistent with the other fields in this JSON block.
| "layout": "\\mathrm{detailed}" | |
| "layout": "\\\\texttt{detailed}" |
| "projects": [ | ||
| { | ||
| "project_name": "\\textbf{xerohour.github.io}", | ||
| "folder_name": "\\texttt{.}", | ||
| "readme_file": "\\texttt{README.md}", | ||
| "summary": "\\parbox{0.78\\linewidth}{Matrix-themed GitHub Pages portfolio with animated effects, anti-scraping contact security, and AI/ML project showcases.}", | ||
| "keywords": [ | ||
| "\\textit{AI/ML}", | ||
| "\\textit{Genome Analysis}", | ||
| "\\textit{Autonomous Agents}", | ||
| "\\textit{Perchance}" | ||
| ] | ||
| }, | ||
| { | ||
| "project_name": "\\textbf{docs}", | ||
| "folder_name": "\\texttt{docs}", | ||
| "readme_file": "\\texttt{docs/README.md}", | ||
| "summary": "\\parbox{0.78\\linewidth}{Minimal documentation hub describing the operator portfolio and linking to the deployed site.}", | ||
| "keywords": [ | ||
| "\\textit{Docs}", | ||
| "\\textit{Portfolio}", | ||
| "\\textit{GitHub Pages}" | ||
| ] | ||
| } | ||
| ] |
There was a problem hiding this comment.
There is an inconsistency between the machine-readable JSON and the human-readable Markdown table. The table (lines 93-96) includes a Detail Level column (High/Medium), but this information is not captured in the projects array within the JSON. Consider adding a detail_level field to the JSON objects to ensure data parity for any tools consuming this payload.
1 participant
Motivation
README.mdso the project index appears in profile contexts.Description
PROJECTS_DASHBOARD.mdfile that enumerates projects found in the repository (root project anddocs) and summarizes each project's name, folder, README source, overview, and highlights.PROJECTS_DASHBOARD.mdwithdashboard_title,style, and aprojectsarray containing escaped LaTeX strings for fields likeproject_name,summary, andkeywords.PROJECTS_DASHBOARD.mdthat mirrors the JSON data for quick browsing.README.mdto add a## 🧭 Project Dashboardsection that links toPROJECTS_DASHBOARD.mdso the dashboard is discoverable from the main profile page.Testing
rg --fileswhich listed the repository files includingREADME.mdanddocs/README.md.cat README.mdandcat docs/README.mdand inspected inserted dashboard link and surrounding lines withnl -ba README.md | sed -n '236,258p'.PROJECTS_DASHBOARD.mdcontents vianl -ba PROJECTS_DASHBOARD.md | sed -n '1,260p'and checked for the dashboard heading usingrg -n "Project Dashboard|## 📝 License" README.md, with all inspections returning the expected content.Codex Task