Skip to content

[EXTERNAL] docs(mini-framework): fix subject and audit file#2961

Merged
zanninso merged 1 commit into01-edu:masterfrom
sadiqui:patch-20
Jul 22, 2025
Merged

[EXTERNAL] docs(mini-framework): fix subject and audit file#2961
zanninso merged 1 commit into01-edu:masterfrom
sadiqui:patch-20

Conversation

@sadiqui
Copy link
Copy Markdown
Contributor

@sadiqui sadiqui commented May 29, 2025

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.

@HarryVasanth HarryVasanth added the 🗂️ docs Documentation label Jun 5, 2025
@HarryVasanth HarryVasanth force-pushed the patch-20 branch 2 times, most recently from 2ad6892 to d7e1c86 Compare June 5, 2025 11:17
@HarryVasanth HarryVasanth dismissed a stale review June 8, 2025 12:08

Non-review approval.

@sadiqui
Copy link
Copy Markdown
Contributor Author

sadiqui commented Jun 17, 2025

@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:

  • Abstracting the DOM
  • Routing System
  • State Management
  • Event Handling

However, because of a missing dash before "Routing System", the list currently renders as (refer to the attached image):

  • Abstracting the DOM Routing System
  • State Management
  • Event Handling

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.

image

@MSilva95 MSilva95 self-requested a review July 11, 2025 10:20
@Oumaimafisaoui Oumaimafisaoui requested review from zanninso and removed request for MSilva95 July 14, 2025 08:07
Copy link
Copy Markdown
Contributor

@zanninso zanninso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@zanninso zanninso merged commit 4844b5d into 01-edu:master Jul 22, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🗂️ docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants