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

[SPIKE] Explore alternate pattern layout #1540

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jorytindall
Copy link
Contributor

📌 Summary

This is a bit of an exploration around how to reorganize the content within the filter patterns documentation and how to break the content down a bit more so it's easier to digest.

This more or less mimics the foundations page.

🔧 Details

In this PR I've:

  • Reorganized the content so that Filter patterns lives in it's own section
  • Added this content to the sidebar on the Patterns template page
  • Mimicked the folder structure for other content

What still needs to be addressed/open questions:

Without changing the logic for how the table of contents and "sections" are generated, Filter patterns now lives in it's own folder outside of patterns more broadly. I don't think this is the correct path, but I don't understand enough about how the controller works to change how nested directories are captured (yet, at least).

Now that each "area" of the filter pattern documentation lives on it's own, additional work needs to occur to further break down this content into tabs

I added some quick updates in imagery and metadata to showcase each section, but this will likely need to be revisited.

💬 Please consider using conventional comments when reviewing this PR.

@vercel
Copy link

vercel bot commented Jul 28, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Jul 28, 2023 11:52pm
hds-website ✅ Ready (Inspect) Visit Preview Jul 28, 2023 11:52pm

@hashibot-hds hashibot-hds added the docs-website Content updates to the documentation website label Jul 28, 2023
@didoo
Copy link
Contributor

didoo commented Aug 3, 2023

@jorytindall maybe worth a sync meeting (with who's interested/wants to participate)? would be easier to discuss pros/cons of the different options and brainstorm alternatives (it's mainly an IA/content organization problem, but with some technical limitations due to how routing works in Ember)

@heatherlarsen
Copy link
Contributor

+1 to what @didoo said. I think learning more about the technical limitations and working through this synchronously would be easier.

@jorytindall jorytindall marked this pull request as draft August 9, 2023 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants