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

[ Plan] Proposed new IA #27

Closed
wants to merge 1 commit into from
Closed

[ Plan] Proposed new IA #27

wants to merge 1 commit into from

Conversation

michaelwarren1106
Copy link
Collaborator

Tear it up!

~MW

@netlify
Copy link

netlify bot commented May 1, 2022

Deploy Preview for web-components-cg ready!

Name Link
🔨 Latest commit a573781
🔍 Latest deploy log https://app.netlify.com/sites/web-components-cg/deploys/626ecad0b43f7d00081b2b22
😎 Deploy Preview https://deploy-preview-27--web-components-cg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Comment on lines +60 to +63
- /build-a-web-component
- /:step-number
- web-components-explained
- /:article-slug
Copy link
Contributor

Choose a reason for hiding this comment

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

Feel like we got close to agreeing that a minimum viable content might focus on just these sections or a subset of the content the might belong in them, and we see that in #26, should we include a MVC IA here?

Copy link
Collaborator Author

@michaelwarren1106 michaelwarren1106 May 3, 2022

Choose a reason for hiding this comment

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

personally, I would consider this IA to be mostly MVC IA, because there's really not much to it. Depending of course on how the conversation goes about the component catalog, and CMS-based site stuff. If we become more tech bloggy in our presentation, I'd think that a collection of some articles would also become MVC, but thats already kind accounted for here in this IA, would just be a matter of how many blogroll articles we start with, etc.

Copy link
Collaborator

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

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

Awesome, thanks for putting this all together @michaelwarren1106 🙏

Left a couple of thoughts of my own for the group review and chime in on as well.

- popular framework features that can be implemented with Web Components
- SSR, SSG, etc explain only that there are ways to do it, not the "how, with code samples"
- **Educate**
- Provide basic, generic MDN-like documentation for WC topics
Copy link
Collaborator

@thescientist13 thescientist13 May 23, 2022

Choose a reason for hiding this comment

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

Provide basic, generic MDN-like documentation for WC topics

As it relates to "MDN-like" docs, it might be good to tease this out because I think it will be important for all contributors to understand how to differentiate any of our technical content from the MDN docs. Perhaps the distinction could come through things like:

  • our tone / approach (less technical / reference / dry)
  • more guide / outcome driven (step 1, then step 2, ???, profit)
  • other?

Full with page descriptions [below](#full-ia)

- Root /
- /our-work
Copy link
Collaborator

Choose a reason for hiding this comment

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

Unless i am interpreting it incorrectly, this seems like it would come out to be 10 top level navigation items?

  1. / (Home)
  2. /our-work
  3. /build-a-web-component
  4. web-components-explained
  5. /featured-components
  6. /submit-component
  7. /articles
  8. /become-an-author
  9. /highlight-article
  10. /about

Perhaps something a little more compact could be a little less daunting for responsive design maintenance, and for user navigation?

  1. / (Home) - featured items would not be a route, just a tile / section on the home page
    • featured component(s)
    • highlighted article(s)
  2. /catalog
    • /browse
    • /submit-component
  3. /articles
    • /web-components-explained
    • /build-a-web-component
  4. /about
    • /our-work
    • /become-an-author

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

i didnt really touch on what would land in the nav vs page that would be accessible by other means. We could definitely divide up the links into "main nav" and "utility nav" though so that we only have a few items in the main nav.

imo stuff like "submit a component" and "become an author" totally dont belong in the main nav. I was just doing a sitemap style organization. i definitely didnt touch on navigation items, but thats something i can totally add!

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah, then indeed I may be a little ahead of the curve. 😅

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.

3 participants