Add project portfolio dashboard (PROJECTS_DASHBOARD.md) and README link#2
Add project portfolio dashboard (PROJECTS_DASHBOARD.md) and README link#2xerohour wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive project portfolio dashboard in PROJECTS_DASHBOARD.md, featuring project indices in Markdown, LaTeX, and JSON formats, and links it from the main README.md. Feedback focuses on improving the LaTeX table's column formatting for better text wrapping, standardizing project descriptions across the various formats to ensure consistency, and unifying the folder naming convention for the repository root.
| \begin{table}[ht] | ||
| \centering | ||
| \caption{xerohour.github.io Project Inventory} | ||
| \begin{tabular}{|c|l|l|l|} |
There was a problem hiding this comment.
The LaTeX tabular environment uses the l (left-aligned) column type for the 'Focus' column. Since the content in this column (lines 55 and 57) is relatively long, it will not automatically wrap, which can cause the table to exceed the page width in a rendered document. Consider using a fixed-width column type like p{width} (e.g., p{6cm}) to ensure the text wraps correctly.
| \begin{tabular}{|c|l|l|l|} | |
| \begin{tabular}{|c|l|l|p{6cm}|} |
| | 1 | xerohour.github.io | `/` (repository root) | `README.md` | Matrix-themed GitHub Pages portfolio for AI/ML work, projects, and contact gateway | [Open](./README.md) | | ||
| | 2 | System Operator Portfolio (Docs Landing) | `docs` | `docs/README.md` | Lightweight docs entrypoint for the hosted portfolio and operator profile | [Open](./docs/README.md) | | ||
|
|
||
| --- | ||
|
|
||
| ## Plugin Dashboard Markdown Table | ||
|
|
||
| | Plugin Key | Display Name | Source Folder | Type | README Parsed | Summary | Health | | ||
| |---|---|---|---|---|---|---| | ||
| | `profile-root` | `xerohour.github.io` | `/` | `portfolio-site` | ✅ | Matrix-themed personal GitHub Pages hub with AI/ML focus, featured projects, encrypted contact UX, and rich profile metadata. | 🟢 Stable | | ||
| | `docs-landing` | `System Operator Portfolio` | `docs` | `documentation` | ✅ | Minimal documentation landing page describing operator identity, status, and canonical site URL. | 🟢 Stable | | ||
|
|
||
| --- | ||
|
|
||
| ## LaTeX Summary Matrix | ||
|
|
||
| ```latex | ||
| \begin{table}[ht] | ||
| \centering | ||
| \caption{xerohour.github.io Project Inventory} | ||
| \begin{tabular}{|c|l|l|l|} | ||
| \hline | ||
| \textbf{ID} & \textbf{Project Name} & \textbf{Folder} & \textbf{Focus} \\ | ||
| \hline | ||
| 1 & xerohour.github.io & / & Matrix-themed GitHub Pages portfolio for AI/ML projects \\ | ||
| \hline | ||
| 2 & System Operator Portfolio (Docs Landing) & docs & Documentation landing page for hosted portfolio \\ | ||
| \hline | ||
| \end{tabular} | ||
| \end{table} | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Structured JSON Payload | ||
|
|
||
| ```json | ||
| { | ||
| "dashboard_version": "1.0.0", | ||
| "repository": "xerohour.github.io", | ||
| "generated_for": "github-profile", | ||
| "formats": ["markdown", "latex", "json"], | ||
| "projects": [ | ||
| { | ||
| "id": 1, | ||
| "project_name": "xerohour.github.io", | ||
| "folder_name": "/", | ||
| "readme_path": "README.md", | ||
| "readme_title": "<xerohour/>", | ||
| "project_type": "portfolio-site", | ||
| "summary": "Matrix-themed GitHub Pages portfolio featuring AI/ML developer profile, project showcases, anti-scraping contact protection, and themed UI components.", |
There was a problem hiding this comment.
There is significant inconsistency in the project summaries and descriptions across the different formats (Project Index table, Plugin Dashboard table, LaTeX matrix, and JSON payload). For example, the description for xerohour.github.io varies in length and detail in each section. To improve maintainability and ensure a single source of truth, consider standardizing these descriptions or using a script to generate all sections from a single data source.
|
|
||
| | # | Project Name | Folder Name | README Path | Primary Focus | Profile Link | | ||
| |---:|---|---|---|---|---| | ||
| | 1 | xerohour.github.io | `/` (repository root) | `README.md` | Matrix-themed GitHub Pages portfolio for AI/ML work, projects, and contact gateway | [Open](./README.md) | |
There was a problem hiding this comment.
The 'Folder Name' column in the Project Index table uses / (repository root) for the root directory, whereas the Plugin Dashboard table (line 40) and the JSON payload (line 77) use just /. For consistency across the dashboard, it is better to use a uniform representation for the root path.
| | 1 | xerohour.github.io | `/` (repository root) | `README.md` | Matrix-themed GitHub Pages portfolio for AI/ML work, projects, and contact gateway | [Open](./README.md) | | |
| | 1 | xerohour.github.io | / | README.md | Matrix-themed GitHub Pages portfolio for AI/ML work, projects, and contact gateway | [Open](./README.md) | |
Motivation
README.mdand exposes README-derived metadata for the GitHub Pages profile.Description
PROJECTS_DASHBOARD.mdcontaining a table-of-contents, a project index, a plugin dashboard markdown table, a LaTeX summary matrix, a structured JSON payload, and README-derived insights.README.mdto insert aProject Dashboardsection that links toPROJECTS_DASHBOARD.mdfor prominent profile visibility.README.mdanddocs/README.md) including summaries, tags, and status fields in the JSON payload.Testing
rg --filesto enumerate files and confirm folders withREADME.md, which succeeded.README.mdanddocs/README.mdwithcatto extract titles and summaries for inclusion, which succeeded.PROJECTS_DASHBOARD.mdwithnl -ba/sedto validate the generated sections and formatting, which displayed as expected.Codex Task