Skip to content

Included a mermaid diagram to our contribution file #498

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.

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

Conversation

TimOsahenru
Copy link
Contributor

Add mermaid diagram to our contribution file to help contributors understand how the system was setup.The diagrams covers: website and development structure, and how some information is generated.

Related issue: #402

Copy link
Contributor

@kjaymiller kjaymiller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TimOsahenru - Great work! Please comment on the one question.

CONTRIBUTING.md Outdated
Comment on lines 56 to 65
flowchart TD
about.md --> _layouts/default.html
about.md --> _includes/header.html
about.md --> _includes/footer.html
about.md --> _config.yml
_layouts/default.html --> about.html
_config.yml --> about.html
about.html --> assets/css/style.css
about.html --> assets/js/script.js
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work on this. Just wondering doesn't the header and footer template loaded from the default layout and not the markdown file itself?

Copy link
Contributor Author

@TimOsahenru TimOsahenru Oct 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're absolutely right. it should be -layout/default.html, making a fix now. Thanks

@kjaymiller kjaymiller merged commit 12b0f74 into BlackPythonDevs:gh-pages Oct 7, 2024
2 checks passed
@TimOsahenru TimOsahenru deleted the mermaid-diagram-for-easy-contribution branch March 21, 2025 10:14
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.

Create a Mermaid Diagram for the readme.md or contributing.md of the infrastructure in use.
2 participants