SeattleColleges-AD-Practicum-Wiki_44_documentation-team-directory-page#52
SeattleColleges-AD-Practicum-Wiki_44_documentation-team-directory-page#52ErmiyasHailemichael wants to merge 2 commits into
Conversation
|
Reviewed the Team Directory documentation updates and the organization looks clear and beginner-friendly. The added structure and contributor instructions improve readability and navigation throughout the wiki. |
josehorta21
left a comment
There was a problem hiding this comment.
Reviewed the Team Directory page. Thanks @ErmiyasHailemichael for tackling
this — and also for the thoughtful feedback you left on my Onboarding
Guide PR (#50) earlier this week.
The structure is well-organized — Program Leadership, Current Students
table, How to Update This Page, and Navigation links all flow logically
and make the page easy to scan. A few specific observations from the diff:
-
Placeholder rows in the Current Students table (lines 22–24). Three
rows contain*(Your Name)*with@yourusernameplaceholders. Are
these intentional template rows showing contributors how to format their
entries, or were they meant to be removed before review? If they're
meant as a template, it might be cleaner to move them into the "How to
Update This Page" section as a code-formatted example so the actual
table only shows real contributors. -
Navigation links should be verified. The footer links to wiki pages
like/wiki/New-Student-Onboarding,/wiki/Guides-and-Resources,
/wiki/Active-Projects,/wiki/Code-of-Conduct, and/wiki/FAQ. Worth
confirming each of these wiki pages exists, otherwise contributors will
hit broken links from the directory. -
File location consistency. The file lives at
docs/team-directory.md,
while my in-progress Onboarding Guide (#50) sits at
Onboarding/Onboarding-Guide.md. The repo seems to be evolving toward
topic-named folders (Onboarding/,Issue-Creation/,belindas-closet/).
No blocker for this PR, but worth aligning on a convention
(docs/vs topic-folder) at the team level so future docs stay
predictable. -
+1 to @ching202's comment that the structure improves readability and
navigation. Having a single source of truth for who's contributing
what really helps onboarding. -
"How to Update This Page" section is a nice touch. Concrete steps
for adding a new row make this self-service for contributors — much
better than asking a maintainer to update the page every time someone
joins.
One small suggestion for the table itself: consider adding a "Role" or
"Track" column with finer granularity (e.g., Frontend Dev, Backend Dev,
Documentation, PM) since "Developer | TBD" is fairly broad for a directory
meant to help people find who's working on what.
Overall a solid addition. Main thing to clarify before merge is the intent
of the placeholder rows.
Updated the Current Students table format to include a 'Track' column and modified instructions accordingly.
|
Thanks for the detailed feedback! Here's what I updated based on your review:
Regarding file location consistency ( Let me know if anything else needs adjusting! |
Summary & Changes 📃
#44docs/team-directory.mdfor version control.docs/team-directory.mdwith team directory contentScreenshots / Visual Aids 🔎
📌 Required for: UI changes, layout updates, or bug fixes.
Expand ⬇️
How to Test 🧪
Checklist ✅
Resolves #44).