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

Docs: How Renovate Works overview #25091

Closed
rarkins opened this issue Oct 8, 2023 · 3 comments · Fixed by #25108
Closed

Docs: How Renovate Works overview #25091

rarkins opened this issue Oct 8, 2023 · 3 comments · Fixed by #25108
Assignees
Labels
priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation

Comments

@rarkins
Copy link
Collaborator

rarkins commented Oct 8, 2023

Describe the proposed change(s).

Add a "How Renovate Works" high level overview for people who wish to understand the internals a little better. e.g. global config load, platforms, modules, datasources, and the overview "flow" (including cleaning up stale branches).

Discussed in #11237 (comment) and onwards

@rarkins rarkins added priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation labels Oct 8, 2023
@azro352
Copy link
Contributor

azro352 commented Oct 8, 2023

I'd like to propose myself to try that , after using several features I was disappointed that the doc doesn't explai much the flow and the parts of it. So i've already started to navigate through the code

I've started to write that down as a mermaid graph, but I'm unsure if it will be easy to render that in the github pages (need to create hml and load mermaid.js)

May I open a PR and link to this ?

@HonkingGoose
Copy link
Collaborator

Our docs generating framework can show Mermaid diagrams. We only need to change the docs configuration.

I suspect that the Mermaid diagrams are useless if you can't see well. So we also need to have the explanation in plain text.

Material for MkDocs, diagram support

@renovate-release
Copy link
Collaborator

🎉 This issue has been resolved in version 37.105.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants