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

Activity Diagram to Flow.md #97

Merged
merged 3 commits into from
Jan 3, 2024
Merged

Activity Diagram to Flow.md #97

merged 3 commits into from
Jan 3, 2024

Conversation

eviterin
Copy link
Collaborator

@eviterin eviterin commented Jan 2, 2024

Context (Problem, Motivation, Solution)

IMO: Logic will only get more complicated. Better to start documenting it now, and keep it up to date.

Describe Your Changes

Added a diagram flow for New Game in flow.md.
Added a folder for assets in docs folder.
Added the UML (both .png and .uml) in the assets folder.

Checklist

  • I have performed a self-review of my code
  • I ran make check and fixed resulting issues
    I get warnings. Is that fine?
  • I ran the relevant tests and they all pass
  • I wrote tests for my new features, or added regression tests for the bug I fixed

Testing

I manually checked that flow.md was rendering the expected image.

@eviterin eviterin mentioned this pull request Jan 2, 2024
4 tasks
@norswap
Copy link
Member

norswap commented Jan 3, 2024

Seems good! Last ask, can you avoid reformating the indentation on the markdown file?

@eviterin
Copy link
Collaborator Author

eviterin commented Jan 3, 2024

I think I fixed the indentation you were talking about.

@norswap norswap merged commit 945db92 into 0xFableOrg:master Jan 3, 2024
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.

2 participants