Peer Review by T14 - MG - Module Decomposition & Use Hierarchy - inconsistent relationships between modules

Open
#323 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
Half a day
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
tex
Domain
documentation

Research direction

The three inconsistencies sit between the prose in sections 7.2.5 and 7.2.11 and Figure 1 of the Module Guide, plus the descriptions of M7, M9, M10 and M13. Find the LaTeX source for those sections and the figure in the repository, and check which module-use edges the diagram draws. Done means each named dependency (M13 to M9, M7 to M9/M13, M10 to M13) is either drawn in Figure 1 and justified in the module text, or removed from the prose. Confirm with the reviewing team (@MelvinMo) which side should change, since the issue does not say.

Written by the indexing model from the issue text.

Description

documentation Peer Review

Artifact Under Review

Module Guide (MG)

Team Number for Team Doing the Review

Team Number 14

Description of Issue

  • Section 7.2.11 says M13 (Central Hub Module) provides resource generation rates and modifiers to M9 (Combat Encounter Module), but Figure 1 has no M9--M13 edge.
  • Section 7.2.5 says M7 (Game World Module) is the main control for moving into combat and the central hub, but Figure 1 has no edge from M7 to M9 or M13.
  • Figure 1 shows M10 (Player Character Module) using M13, but neither module's description says why the player character depends on the central hub.
Closing Remarks

Decomposition strong overall, great content.

@MelvinMo

Dominant language
TeX
Stars
0
Forks
0
Avg merge
1d 7h
Merged PRs (30d)
52

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Aeolus-Software/RealmForge

All issues in Aeolus-Software/RealmForge

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.