Skip to content

docs: align platform documentation and add clarifying comments#81

Closed
enekoreto wants to merge 8 commits intomainfrom
documentation
Closed

docs: align platform documentation and add clarifying comments#81
enekoreto wants to merge 8 commits intomainfrom
documentation

Conversation

@enekoreto
Copy link
Copy Markdown
Collaborator

@enekoreto enekoreto commented Mar 17, 2026

Description

This PR standardises and corrects documentation for the current platform behaviour, and adds concise clarifying comments/docstrings in core files where logic was non-obvious.

Scope

  • Updated top-level project documentation and added an E2E runbook.
  • Corrected Terraform documentation to reflect implemented routes/modules (including history_list).
  • Rewrote bootstrap documentation to match the actual bootstrap folder and backend values.
  • Added lightweight fixture documentation.
  • Added brief explanatory comments/docstrings in workflow, frontend utilities, worker, Lambda handlers, and API client scripts.

Behavioural impact

  • No functional or infrastructure behaviour changes intended.
  • Changes are documentation/commentary only.

Validation

  • Verified markdown links resolve across tracked documentation files.
  • Confirmed branch CI status: Terraform CI passed.

Reviewer notes

Please review for clarity, accuracy, and consistency with current team operating policy (shared dev infrastructure preserved; EC2-only E2E cleanup).

Comment thread .github/workflows/e2e-notebook-deploy-and-run.yml Outdated
Comment thread demo_input/lightweight-notebooks/README.md Outdated
Comment thread demo_input/lightweight-notebooks/README.md Outdated
Comment thread demo_input/lightweight-notebooks/README.md Outdated
Comment thread demo_input/lightweight-notebooks/README.md Outdated
Comment thread worker/worker.py Outdated
Comment thread readme.md Outdated
Comment thread readme.md Outdated
Comment thread readme.md Outdated
Comment thread readme.md Outdated
@prathikanand7 prathikanand7 dismissed GiorgosNik’s stale review March 22, 2026 14:41

Hi, the requested changes have been implemented, so I am dismissing the remarks now.

@prathikanand7 prathikanand7 marked this pull request as draft March 22, 2026 14:43
Co-authored-by: Giorgos Nikolaou <giorgosnl17@gmail.com>
@prathikanand7
Copy link
Copy Markdown
Owner

Closing this PR.

@prathikanand7 prathikanand7 deleted the documentation branch March 22, 2026 15:39
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.

3 participants