Skip to content
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

Create high level architectural diagram #362

Open
Ainali opened this issue Mar 15, 2024 · 1 comment
Open

Create high level architectural diagram #362

Ainali opened this issue Mar 15, 2024 · 1 comment
Labels
documentation ✍️ Improvements or additions to documentation enhancement 🥇 New feature or request

Comments

@Ainali
Copy link
Member

Ainali commented Mar 15, 2024

The feature

Create a high level architectural diagram that explains how the different pages are generated and how the data is collected and from where.

Why?

This would help new users understand how the website is built and guide them on how to suggest, or work on, improvements.

The Standard for Public Code also says:

The documentation SHOULD describe the key components or modules of the codebase and their relationships, for example as a high level architectural diagram.

Examples and inspiration

No response

@Ainali Ainali added documentation ✍️ Improvements or additions to documentation enhancement 🥇 New feature or request labels Mar 15, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Roadmap Aug 30, 2024
@Abbe98
Copy link
Member

Abbe98 commented Oct 22, 2024

Note to self: It would be nice if one could generate this from any Snowman views.yaml file.

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 enhancement 🥇 New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

2 participants