Skip to content

docs: Improve documentation#430

Open
CDiezRodriguez wants to merge 13 commits intomainfrom
docs/improve-project-documentation-structure-and-completeness
Open

docs: Improve documentation#430
CDiezRodriguez wants to merge 13 commits intomainfrom
docs/improve-project-documentation-structure-and-completeness

Conversation

@CDiezRodriguez
Copy link
Copy Markdown
Contributor

@CDiezRodriguez CDiezRodriguez commented Feb 11, 2026

WHAT

Improve the project documentation.

WHY

To provide more information about the project.

Closes #427

@CDiezRodriguez CDiezRodriguez self-assigned this Feb 11, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 11, 2026 •
edited
Loading

🧪 Test Summary

🎉 Status: SUCCESS

📊 Backend Tests

Passed Failed Total Coverage
✅ 147 ❌ 0 📋 147 📈 60.08%
Run Details
  • Branch: 430/merge
  • Commit: 4efd70a7a221f121fede0c1ae7a5855d660fd3f4
  • Trigger: pull_request

@CDiezRodriguez
docs: add comprehensive Quickstart Guide for Industry Core Hub setup
58f1fd1
@CDiezRodriguez
docs: enhance installation documentation with Quickstart Guide refere…
3137756 
…nces
@CDiezRodriguez
docs: add comprehensive guides for performance tuning, security harde…
d21d12f 
…ning, troubleshooting, and database management
@CDiezRodriguez
docs: enhance Code Architecture Guide with detailed project structure…
b0d7e0c 
… and backend/frontend architecture
@CDiezRodriguez
docs: improve database schema documentation with detailed tables, rel…
34caa98 
…ationships, and constraints
@CDiezRodriguez
docs: add PARTICIPANT_ID configuration to Quickstart Guide setup script
a3a09fb
@CDiezRodriguez
docs: enhance database schema with ichub schema and related tables fo…
d842f33 
…r improved data management
@CDiezRodriguez
docs: enhance database management documentation with detailed operati…
0d91998 
…onal guide, configuration, and backup procedures
@CDiezRodriguez
fix: update copyright information in multiple documentation files to …
e396aac 
…reflect fixed ownership
@CDiezRodriguez
docs: enhance Data Seeding Guide with detailed instructions, constrai…
f2ee379 
…nts, and sample data
@CDiezRodriguez
docs: enhance installation guide with optional Docker image build and…
7b4d5bc 
… load instructions for local development
@matbmoser
Copy link
Copy Markdown
Contributor

matbmoser commented Feb 27, 2026

whatever documentation is welcomed!

matbmoser
matbmoser requested changes Apr 14, 2026
View reviewed changes
Comment thread docs/SECURITY_HARDENING.md Outdated
@matbmoser
Copy link
Copy Markdown
Contributor

matbmoser commented Apr 14, 2026

@CDiezRodriguez please provide an update to this PR

@matbmoser matbmoser marked this pull request as ready for review April 14, 2026 07:25
@CDiezRodriguez
Copy link
Copy Markdown
Contributor Author

CDiezRodriguez commented Apr 14, 2026

@copilot Remove documentation files that only contain license text or "TBD". Sync with main and check for any unnecessary docs or text that may have been introduced.

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 14, 2026

@copilot Remove documentation files that only contain license text or "TBD". Sync with main and check for any unnecessary docs or text that may have been introduced.

Done in fb25f46. Removed 14 documentation files that only contained license text and "TBD" placeholders (SECURITY_HARDENING.md, PERFORMANCE_TUNING.md, TROUBLESHOOTING.md, and 11 others under admin/, developer/, and user/). Also updated docs/README.md to remove all dead links to the deleted files. The branch has been synced with main.

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

Reviewers

@matbmoser matbmoser matbmoser requested changes

+1 more reviewer

Copilot code review Copilot Copilot left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@CDiezRodriguez CDiezRodriguez

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve Project Documentation Structure and Completeness

3 participants

@CDiezRodriguez @matbmoser
⚡