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

[Markdown] Preparing CSS docs for Markdowning #5865

Closed
13 tasks done
wbamberg opened this issue Jun 10, 2021 · 3 comments
Closed
13 tasks done

[Markdown] Preparing CSS docs for Markdowning #5865

wbamberg opened this issue Jun 10, 2021 · 3 comments
Labels
needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.

Comments

@wbamberg
Copy link
Collaborator

wbamberg commented Jun 10, 2021

This is a tracking bug for the work we have to do to prepare the CSS documentation for Markdown conversion.

This doesn't list everything we need to do and I'll probably add some things, but gives us a list of the main items at least.

@wbamberg wbamberg added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Jun 10, 2021
@wbamberg wbamberg changed the title [Markdown] Preparing CSS docs [Markdown] Preparing CSS docs for Markdowning Jun 10, 2021
@hamishwillee
Copy link
Collaborator

Re "remove id attributes except on headings (#3647)"

The interesting thing is that I believe the anchor gets auto-generated if you don't specify it, and this will happen all the time the moment that we move to markdown. So possibly we should remove all ids in heading that are "correct" for the heading, and then review all the other ones to work out why they are different and fix any potential breaks.

Further, it might be nice to be able to explicitly set an anchor for some headings to prevent them moving around if the heading text changes - or at least have some way of reminding people that changing headings might break links.

@wbamberg
Copy link
Collaborator Author

Re "remove id attributes except on headings (#3647)"

The interesting thing is that I believe the anchor gets auto-generated if you don't specify it, and this will happen all the time the moment that we move to markdown. So possibly we should remove all ids in heading that are "correct" for the heading, and then review all the other ones to work out why they are different and fix any potential breaks.

Further, it might be nice to be able to explicitly set an anchor for some headings to prevent them moving around if the heading text changes - or at least have some way of reminding people that changing headings might break links.

I've started https://github.com/mdn/content/discussions/6322 for this.

@wbamberg
Copy link
Collaborator Author

I've started https://github.com/mdn/content/discussions/7263 to decide what to do about <div class="index">.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.
Projects
None yet
Development

No branches or pull requests

2 participants