Skip to content

Doc/12187 v3 add MODULES.md - a description of how modules work - #13

Closed
KEIAHNY wants to merge 2 commits into
mainfrom
12187-doc-suriconf-pipeline-v3
Closed

Doc/12187 v3 add MODULES.md - a description of how modules work#13
KEIAHNY wants to merge 2 commits into
mainfrom
12187-doc-suriconf-pipeline-v3

Conversation

@KEIAHNY

@KEIAHNY KEIAHNY commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

PR Type

Documentation


Description

  • Created MODULES.md with detailed pipeline documentation

  • Documented Suriconf stages and module configurations

  • Included formulas and logic for parameter estimation

  • Updated README.md to link new module docs


Diagram Walkthrough

flowchart LR
  A["MODULES.md"] -- "linked in" --> B["README.md"]
Loading

File Walkthrough

Relevant files
Documentation
MODULES.md
Add detailed Suriconf pipeline and module documentation   

MODULES.md

  • Added comprehensive documentation for Suriconf pipeline
  • Described preconfiguration and query execution stages
  • Detailed module logic for CPU and memory
  • Included estimation formulas and configuration parameters
+272/-0 
README.md
Link MODULES.md in README modules section                               

README.md

  • Updated modules section to reference MODULES.md
  • Added link for detailed module descriptions
+1/-1     

@KEIAHNY KEIAHNY self-assigned this Aug 13, 2026
@KEIAHNY KEIAHNY added the documentation Improvements or additions to documentation label Aug 13, 2026
@github-actions

Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected

@github-actions

Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@KEIAHNY

KEIAHNY commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator Author

Closing: #14.

@KEIAHNY KEIAHNY closed this Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Review effort 2/5

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant