[EXTERNAL] docs(mini-framework): fix subject and audit file#2961
Merged
zanninso merged 1 commit into01-edu:masterfrom Jul 22, 2025
Merged
[EXTERNAL] docs(mini-framework): fix subject and audit file#2961zanninso merged 1 commit into01-edu:masterfrom
mini-framework): fix subject and audit file#2961zanninso merged 1 commit into01-edu:masterfrom
Conversation
2ad6892 to
d7e1c86
Compare
Contributor
Author
|
@HarryVasanth @Muaytie666 Does this require a new review? The merge is necessary because the current state of the README creates confusion about the minimum requirements for the Mini-Framework project, due to a markup syntax error. The project expects the framework to handle four distinct features:
However, because of a missing dash before "Routing System", the list currently renders as (refer to the attached image):
This makes it appear as if "Abstracting the DOM Routing System" is one item, which is misleading, as there's no such thing conceptually. "Abstracting the DOM" and "Routing System" are two separate and essential requirements. This error may lead some teams to mistakenly implement only three of the four required features. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Fix minor documentation issues: standardized the "Routing System" header format, corrected a typo ("auditers" → "auditors"), and updated the TodoMVC example link to a valid one.