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

feat(#1670): rename and reorganize the design system section #1701

Open
wants to merge 50 commits into
base: main
Choose a base branch
from

Conversation

ZiitheH
Copy link

@ZiitheH ZiitheH commented Nov 11, 2024

Description

Complete revamp of the Design System section. It includes a reorganisation of the existing pages, as well as splitting of pages into more concise ones. To simplify the navigation, it merges all the guides, icons and existing components under Interface.

Additionally. it adds a new section about User Experience Research.

Current navigation:
Screenshot 2024-12-04 at 09 01 42

Proposed navigation:
Screenshot 2024-12-04 at 09 02 12

Closes #1670
Closes #1650

License

The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.

@esthermmoturi
Copy link
Contributor

esthermmoturi commented Nov 13, 2024

Hey @Ziithe and @n-orlowski , I have a couple of questions and items to be addressed:

  1. Some pages like Interface/UI Kit are quite short. Do you plan on adding more content in future?
  2. The images in color.md are not loading correctly - I will work on this and push changes
  3. The current external resources page and mockups page is missing. Has it been moved elsewhere?
  4. Empathy map, problem statement and mapping hierarchy under this section have they been moved or missing?

Copy link
Contributor

@esthermmoturi esthermmoturi left a comment

Choose a reason for hiding this comment

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

I have left a comment with items to be addressed.

@n-orlowski
Copy link
Contributor

I believe @ZiitheH mentioned she synced with you but there are a few things I wanted to clarify:

  1. In the updated version we are removing external resources and integrating with specific sections (ex Material Design will be linked to in the UI page)
  2. Mockups are to be replaced with the Figma UI kit that Ziithe is working on but if we have the external contributer I'm happy to link to the slides in the UI kit page
  3. Empathy map and problem statement are now integrated in the methodologies so we can remove those pages; mapping hierarchy feels like it should be part of configuration but I'm not too sure about this one! What do you think?

@esthermmoturi
Copy link
Contributor

esthermmoturi commented Nov 14, 2024

Thanks for the clarification @n-orlowski , I think we should keep the Empathy map , Editable Mockups , External Resources and Mapping Hierarchy files and purpose to remove them once they have been incorporated in the said pages.

@n-orlowski
Copy link
Contributor

Gotcha! Resources should already be integrated into the content in this branch and empathy mapping is replaced by our updated methodologies (so we should remove this)

@ZiitheH can you please update to reflect this document's architecture? (changes are adding the Mockup page under UI and Mapping Hierarchy as it's own section)

@andrablaj andrablaj dismissed their stale review November 29, 2024 13:05

Dismissing my review as I will finalize the work Ziithe started.

@andrablaj andrablaj removed the request for review from n-orlowski November 29, 2024 13:07
@andrablaj
Copy link
Member

@mrjones-plip this PR is ready for review. 🎆

@andrablaj andrablaj changed the title Update designing feat(#1670): update designing Dec 3, 2024
Copy link
Contributor

@mrjones-plip mrjones-plip left a comment

Choose a reason for hiding this comment

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

Wow - A lot of work went to this with many contributors - impressive!!

Before jumping in can you please update the PR body and the two upstream tickets here and here?

Since I have no background on what we're trying to achieve, I can't tell what this intends to solve, for example:

Create Designing branch with new info arch - So that n-orlowski can populate content 🙏

@andrablaj
Copy link
Member

@mrjones-plip I added details to the PR about I understood that this PR does. Please let me know if you need more details.

@andrablaj andrablaj changed the title feat(#1670): update designing feat(#1670): rename and reorganize the design system section Dec 4, 2024
@mrjones-plip
Copy link
Contributor

Ah - great! It's a night and day difference after you added an image or two and a couple sentences - it's so much more clear what we're doing. Thanks @andrablaj !

Given these large moves can be tricky and inadvertently cause 404s , I wrote a set of checker scripts in another ticket. While a bit of work, I think we should promote these so anyone can run them and they're easy[ier] to find. I'm happy to do the work myself, but I'd like to block this ticket with that work tracked here.

As well, having this documented and in CI will be a great win for new contributors to the docs, including those outside of medic.

@andrablaj
Copy link
Member

@mrjones-plip I agree with the need for a link checker script to be part of CI. Let's keep this in review until we complete that part. I will let you know if I get to have a look at that script before you do.

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.

Create Designing branch with new page structure Update Overview and Interface sections
6 participants