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

Add API overview page for SVG #2646

Closed
wbamberg opened this issue Feb 27, 2020 · 3 comments · Fixed by #11666
Closed

Add API overview page for SVG #2646

wbamberg opened this issue Feb 27, 2020 · 3 comments · Fixed by #11666
Labels
Content:SVG SVG docs Content:WebAPI Web API docs document not written Missing document page

Comments

@wbamberg
Copy link
Collaborator

GroupData.json lists "SVG" as a Web API, but it doesn't have an API overview page. We should write a page and add the "overview" property to GroupData.

@chrisdavidmills chrisdavidmills transferred this issue from mdn/sprints Feb 24, 2021
@Rumyra Rumyra added needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. Content:SVG SVG docs Content:WebAPI Web API docs document not written Missing document page and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Jun 7, 2021
@github-actions github-actions bot added the idle label Nov 24, 2021
@himanshugarg
Copy link
Contributor

Does this qualify for an API overview page?

@github-actions github-actions bot removed the idle label Dec 5, 2021
@hamishwillee
Copy link
Collaborator

@himanshugarg Nearly. I believe the criteria would be that it is under https://developer.mozilla.org/en-US/docs/Web/API/ and https://developer.mozilla.org/en-US/docs/MDN/Structures/Page_types/API_landing_page_template

@wbamberg perhaps we could move/redirect it, update it to match the template. I prefer fewer entry points unless they have a significantly different audience and hence content.

@wbamberg
Copy link
Collaborator Author

wbamberg commented Dec 6, 2021

It's not really an API overview page. It's a top-level overview page (and navigation root) for the SVG technology as a whole, which is mostly expressed as a set of XML-based elements and attributes (just as HTML is).

API overview pages are part of the "Web API" domain, which is a set of specifications describing the JavaScript interfaces implemented in browsers. What we're missing is an overview page for the interfaces that browsers provide that enable JavaScript running in web pages to interact with SVG elements.

These things have a pretty standard structure, consisting of a short overview, a list of all the interfaces, and a spec table. For example: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API.

A rough analogy would be with https://developer.mozilla.org/en-US/docs/Web/CSS and https://developer.mozilla.org/en-US/docs/Web/API/CSS_Object_Model.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:SVG SVG docs Content:WebAPI Web API docs document not written Missing document page
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants