Skip to content

chore: Link to child pages in SVG, URI section#39470

Merged
bsmth merged 11 commits intomdn:mainfrom
bsmth:link-to-child-pages-s-z
May 13, 2025
Merged

chore: Link to child pages in SVG, URI section#39470
bsmth merged 11 commits intomdn:mainfrom
bsmth:link-to-child-pages-s-z

Conversation

@bsmth
Copy link
Copy Markdown
Member

@bsmth bsmth commented May 9, 2025

Description

This PR links to child pages when missing from parent.
Covering the SVG and URI sections.

Relates to:

@bsmth bsmth requested a review from a team as a code owner May 9, 2025 14:30
@bsmth bsmth requested review from hamishwillee and removed request for a team May 9, 2025 14:30
@github-actions github-actions bot added Content:Other Any docs not covered by another "Content:" label Content:SVG SVG docs size/m [PR only] 51-500 LoC changed labels May 9, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 9, 2025

The [URI guides](/en-US/docs/Web/URI/Guides) help you work with URIs on the web.

- [Choosing between www and non-www URLs](Choosing_between_www_and_non-www_URLs)
- : A recurring question among website owners is whether to choose 'www' (`www.example.com`) or 'non-www' (`example.com`) URLs for your projects.
Copy link
Copy Markdown
Member

@Josh-Cena Josh-Cena May 10, 2025

Choose a reason for hiding this comment

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

Why single quotes?

[Rant; feel free to ignore] FWIW this is why I don't like the current IA. The sections below are supposed to be the list of links, but organized in a more organic way, rather than as an uninteresting, unordered list. The URI docs are supposed to be cut by the components, just like API docs are primarily cut by APIs, not by reference/guide.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Why single quotes?

Updated in b16ae2a which I think is a bit clearer.

this is why I don't like the current IA. The sections below are supposed to be the list of links, but organized in a more organic way, rather than as an uninteresting, unordered list. The URI docs are supposed to be cut by the components, just like API docs are primarily cut by APIs, not by reference/guide.

No I appreciate sharing - those are rough edges -> these changes in particular highlight when a landing page for a technology/topic lists everything (all guides & references), then a guide / reference page duplicates a subset of that, it's not so elegant, I agree. At the least, the reference and guide pages should be exhaustive.

For cutting by URI component, do you mean it would be better to have:

./files/en-us/web/uri
├── authority
│   ├── guides
│   └── reference
├── fragment
│   ├── …
│   └── reference
└── schemes
    ├── …
    └── reference

v

./files/en-us/web/uri
├── guides
│   └── choosing_between_www_and_non-www_urls
└── reference
    ├── authority
    ├── fragment
    │   └── text_fragments
    └── schemes
        ├── data
        ├── javascript
        └── resource

https://github.com/mdn/content/tree/main/files/en-us/web/uri/reference

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

For cutting by URI component, do you mean it would be better to have:

Yes that's what I meant.

Copy link
Copy Markdown
Member Author

@bsmth bsmth May 12, 2025

Choose a reason for hiding this comment

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

I guess we could do - currently the section is a little light on content so it's hard to see much of a difference, but this is not a bad way to organize it, indeed.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think it's productive to change everything again—I can live with the current organization. I think if the other sections on the main landing page (URI vs URN & URI structure) get moved it would look a lot cleaner.

Copy link
Copy Markdown
Member Author

@bsmth bsmth May 12, 2025

Choose a reason for hiding this comment

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

Let's revisit this

(URI vs URN & URI structure) get moved it would look a lot cleaner

Definitely, these are some leftovers that we can tidy and flesh out properly.

edit: I understand the suggestion, I'll try tidy the landing page in this PR.

Copy link
Copy Markdown
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

I'm OK with this.

bsmth and others added 2 commits May 12, 2025 09:36
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
- [Choosing between www and non-www URLs](Choosing_between_www_and_non-www_URLs)
- : Guidance on when sites should use a `www.` prefix in URLs (`www.example.com` vs `example.com`).

## URLs and URNs
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Perhaps move this thing to "reference"? It's supposed to be a list of links.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

There were many side effects of moving this, see 54b4e6e

@bsmth bsmth requested review from a team as code owners May 12, 2025 14:49
@bsmth bsmth requested review from dipikabh, estelle and wbamberg and removed request for a team May 12, 2025 14:49
@github-actions github-actions bot added the Content:HTML Hypertext Markup Language docs label May 12, 2025
@github-actions github-actions bot added the Content:WebAPI Web API docs label May 12, 2025
@bsmth bsmth requested review from Josh-Cena and removed request for dipikabh, estelle and wbamberg May 12, 2025 14:50
Copy link
Copy Markdown
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Almost good, thank you!

## Components

- `<NID>`
- : A NID (Namespace Identifier) is a case insensitive identifier for the namespace (e.g., `ISBN` and `isbn` are equivalent).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Who resolves the NID? Perhaps some usage context would be useful (you may do that in a follow up, not a big blocker)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Added basic hints here 5cbb5d2

Noting that this page needs love anyway, it's missing the optional components:

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Copy link
Copy Markdown
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

This looks good, feel free to merge if you think it's ready 💯

We should follow up on the URN page. I'm not sure how useful it is on the web, but still important for completeness.

@bsmth
Copy link
Copy Markdown
Member Author

bsmth commented May 13, 2025

This looks good, feel free to merge if you think it's ready 💯

Great, thanks. I think it's good to merge for now!

We should follow up on the URN page. I'm not sure how useful it is on the web, but still important for completeness.

I agree, I don't think it's that much work, but it would be nice to dedicate some time to it to bring up the quality.

@bsmth bsmth merged commit be9ba40 into mdn:main May 13, 2025
8 checks passed
@bsmth bsmth deleted the link-to-child-pages-s-z branch May 13, 2025 09:13
wbamberg added a commit to wbamberg/content that referenced this pull request May 21, 2025
* upstream/main: (40 commits)
  Add a guide on xs-leaks (mdn#38977)
  chore: Link to child pages in SVG, URI section (mdn#39470)
  Correct page title for `Uint8Array.prototype.setFromHex()` (mdn#39494)
  Bump markdownlint-cli2 from 0.17.2 to 0.18.0 (mdn#39488)
  Add more documentation for sizes=auto (mdn#39464)
  css(fix): update 'shape()' page (mdn#39454)
  Expand Compression Dictionary format description (mdn#39441)
  Add username/password section to URLs guide (mdn#39487)
  Fix typos (mdn#39481)
  CSS: mask-position property description (mdn#39449)
  Adding @starting-style to CSS nesting at-rules (mdn#39473)
  feat(aria): Add short titles, format titles for roles (mdn#39472)
  Fix Circle Collision detection algorithm (mdn#39484)
  Add warning against using element IDs as global properties. (mdn#39422)
  Fix typos in web audio spatialization basics (mdn#39476)
  More Error Messages (mdn#39419)
  Add links to CSS sidebar (mdn#39445)
  css: add 'stretch' value examples (mdn#39451)
  chore: link to unlinked child pages (mdn#39469)
  Fix typos (mdn#39465)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:HTML Hypertext Markup Language docs Content:Other Any docs not covered by another "Content:" label Content:SVG SVG docs Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants