Skip to content

[Automatic Docs] Diagram first docementation for pipelex #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

[Automatic Docs] Diagram first docementation for pipelex #191

wants to merge 12 commits into from

Conversation

@ivanmilevtues
Copy link

@ivanmilevtues ivanmilevtues commented Jul 24, 2025 •
edited
Loading

🔗 Related Issues

📝 Description

In this change I've added CodeBoarding's free github action, which generates diagram first documentation for python projects. I integrated it with your existing mkdoc structure.

pipelex

🔄 Type of Change

  • 🐛 Bug fix
  • ✨ New feature
  • 💥 Breaking change
  • 📚 Documentation update
  • 🧹 Code refactor
  • ⚡ Performance improvement
  • ✅ Test update

🧪 Tests

📋 Checklist

  • Linting / type-checking / unit tests pass locally with my changes
  • I've added tests that prove my fix is effective or that my feature works
  • My code follows the style guidelines of this project
  • I've made corresponding changes to the documentation
  • My changes generate no new warnings

ivanmilevtues and others added 4 commits July 24, 2025 00:11
@ivanmilevtues
Added workflows.
b5ff219
@actions-user
docs: update codeboarding documentation in advanced-customization
f06826a 
## 📚 Documentation Update
This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section.

### 📊 Summary
- Documentation files created/updated: 8
- JSON files created/updated: 9
- Documentation directory: .codeboarding/
- JSON directory: .codeboarding/
- Output format: .md
- Repository analyzed: https://github.com/CodeBoarding/pipelex
- Destination: docs/pages/advanced-customization/

The generated .md files have been automatically copied to the advanced-customization documentation section.

🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
@ivanmilevtues
Added generated docs to the mkdoc
e219783
@ivanmilevtues
Fixed links to the main repo from fork.
0b740a1
@github-actions
Copy link


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

I have read the CLA Document and I hereby sign the CLA

0 out of 2 committers have signed the CLA.
❌ @ivanmilevtues
❌ @actions-user
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@ivanmilevtues
Copy link
Author

Unsure how to sign the CLA, but considered it signed when I understand how to do that :D

@actions-user
docs: update codeboarding documentation in advanced-customization
4ec0967 
## 📚 Documentation Update
This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section.

### 📊 Summary
- Documentation files created/updated: 8
- JSON files created/updated: 9
- Documentation directory: .codeboarding/
- JSON directory: .codeboarding/
- Output format: .md
- Repository analyzed: https://github.com/Pipelex/pipelex
- Destination: docs/pages/advanced-customization/

The generated .md files have been automatically copied to the advanced-customization documentation section.

🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
@actions-user
docs: update codeboarding documentation in advanced-customization
584cecf 
## 📚 Documentation Update
This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section.

### 📊 Summary
- Documentation files created/updated: 8
- JSON files created/updated: 9
- Documentation directory: .codeboarding/
- JSON directory: .codeboarding/
- Output format: .md
- Repository analyzed: https://github.com/Pipelex/pipelex
- Destination: docs/pages/advanced-customization/

The generated .md files have been automatically copied to the advanced-customization documentation section.

🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
@actions-user
docs: update codeboarding documentation in advanced-customization
47b3151 
## 📚 Documentation Update
This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section.

### 📊 Summary
- Documentation files created/updated: 6
- JSON files created/updated: 7
- Documentation directory: .codeboarding/
- JSON directory: .codeboarding/
- Output format: .md
- Repository analyzed: https://github.com/Pipelex/pipelex
- Destination: docs/pages/advanced-customization/

The generated .md files have been automatically copied to the advanced-customization documentation section.

🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
@Josephrp
Copy link

hey i was actually going to use pipelex to make a mermaid docs gen agent pipeline for code repos (just using existing pipelex library) would you be interested in working together on that ?

@actions-user
docs: update codeboarding documentation in advanced-customization
33da0a0 
## 📚 Documentation Update
This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section.

### 📊 Summary
- Documentation files created/updated: 7
- JSON files created/updated: 8
- Documentation directory: .codeboarding/
- JSON directory: .codeboarding/
- Output format: .md
- Repository analyzed: https://github.com/Pipelex/pipelex
- Destination: docs/pages/advanced-customization/

The generated .md files have been automatically copied to the advanced-customization documentation section.

🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
@ivanmilevtues
Copy link
Author

@Josephrp I don't have much time at the moment. But we can do a quick chat and discuss it. Let me know when you'd have time for it, you can directly book some time with me: https://calendly.com/ivan-i-milev/codeboarding-demo

@actions-user
docs: update codeboarding documentation in advanced-customization
2720cc8 
## 📚 Documentation Update
This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section.

### 📊 Summary
- Documentation files created/updated: 8
- JSON files created/updated: 9
- Documentation directory: .codeboarding/
- JSON directory: .codeboarding/
- Output format: .md
- Repository analyzed: https://github.com/Pipelex/pipelex
- Destination: docs/pages/advanced-customization/

The generated .md files have been automatically copied to the advanced-customization documentation section.

🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
@thomashebrard
Copy link
Member

thomashebrard commented Sep 10, 2025 •
edited
Loading

@Josephrp I don't have much time at the moment. But we can do a quick chat and discuss it. Let me know when you'd have time for it, you can directly book some time with me: https://calendly.com/ivan-i-milev/codeboarding-demo

Hello guys, @Josephrp, @ivanmilevtues. I would love to discuss CodeBoarding and the applications around it with you.
Would you be open to take some time in a voice channel on the Pipelex Discord to talk more about CodeBoarding, and @Josephrp's project?
And we could also discuss the integration of CodeBoarding

@ivanmilevtues
Copy link
Author

@thomashebrard I joined the discord so we can discuss some time. I will follow up there :)

@actions-user
docs: update codeboarding documentation in advanced-customization
60b9b7f 
## 📚 Documentation Update
This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section.

### 📊 Summary
- Documentation files created/updated: 6
- JSON files created/updated: 7
- Documentation directory: .codeboarding/
- JSON directory: .codeboarding/
- Output format: .md
- Repository analyzed: https://github.com/Pipelex/pipelex
- Destination: docs/pages/advanced-customization/

The generated .md files have been automatically copied to the advanced-customization documentation section.

🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
@actions-user
docs: update codeboarding documentation in advanced-customization
e35334a 
## 📚 Documentation Update
This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section.

### 📊 Summary
- Documentation files created/updated: 8
- JSON files created/updated: 9
- Documentation directory: .codeboarding/
- JSON directory: .codeboarding/
- Output format: .md
- Repository analyzed: https://github.com/Pipelex/pipelex
- Destination: docs/pages/advanced-customization/

The generated .md files have been automatically copied to the advanced-customization documentation section.

🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
@actions-user
docs: update codeboarding documentation in advanced-customization
78f618d 
## 📚 Documentation Update
This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section.

### 📊 Summary
- Documentation files created/updated: 5
- JSON files created/updated: 6
- Documentation directory: .codeboarding/
- JSON directory: .codeboarding/
- Output format: .md
- Repository analyzed: https://github.com/Pipelex/pipelex
- Destination: docs/pages/advanced-customization/

The generated .md files have been automatically copied to the advanced-customization documentation section.

🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ivanmilevtues @Josephrp @thomashebrard @actions-user