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

Add program flow page to developer guide #1224

Merged
merged 1 commit into from
Jan 12, 2021

Conversation

ang-zeyu
Copy link
Contributor

@ang-zeyu ang-zeyu commented May 6, 2020

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [x] Documentation update

Resolves #812
Part of #1027

What is the rationale for this request?

  • introduce the architecture of markbind and key processes in generating sites

What changes did you make? (Give an overview)

  • Add program flow page to developer guide with two activity diagrams illustrating the key processes
  • remove outdated / redundant info in devGuide.md

Proposed commit message: (wrap lines at 72 characters)
Add program flow to developer guide

@ang-zeyu
Copy link
Contributor Author

@ang-zeyu ang-zeyu removed the s.OnHold label Dec 30, 2020
@wxwxwxwx9
Copy link
Contributor

@ang-zeyu sorry for the late response! I have taken a look at it and compared it with the codebase. It seems pretty accurate and clear. I think it's good! At first, I was wondering if we should also include PluginManager but perhaps it isn't that relevant to the diagram, right? Since it isn't involved in the content processing flow.

@ang-zeyu
Copy link
Contributor Author

ang-zeyu commented Jan 3, 2021

thanks for the comments! @wxwxwxwx9

I've made some changes to the diagram and added some additional snippets of info elsewhere for the points you raised:

  • not too clear that content processing flow is for a single source file - added a popover
  • <panel>s (Externals) are separate from the content processing flow - added some tip boxes

let me know if there's anything else that can be improved here 🙂

@ryoarmanda
Copy link
Contributor

Just checked the docs and the diagram looks nice! It shows a clear organization of the classes and flows, and the writeup is good for a high-level overview. Looks quite complete as well, so far most of the things I noticed first time through the codebase have been addressed 👍

@ang-zeyu ang-zeyu closed this Jan 4, 2021
@ang-zeyu ang-zeyu reopened this Jan 4, 2021
@ang-zeyu ang-zeyu merged commit d85aedc into MarkBind:master Jan 12, 2021
@ang-zeyu
Copy link
Contributor Author

Merged. Thanks again for the review : ) @wxwxwxwx9 @ryoarmanda

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.

Add an activity diagram to the developer guide to illustrate how MarkBind generates sites
3 participants