Skip to content

Commit ba8d297

Browse files
authored
Links, Contributing & JSON
1 parent 46ffb23 commit ba8d297

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,32 @@
22

33
Welcome to the repository for the [Sustainable Web Design Community Group](https://www.w3.org/community/sustyweb/).
44

5-
In this hub, you will find the draft specification for our [Web Sustainability Guidelines](https://w3c.github.io/sustyweb/) and any supplementary documentation, such as our [at-a-glance](https://w3c.github.io/sustyweb/glance.html) overview. We also have a living implementation of the specification under active development called [Sustainable Web Design](https://sustainablewebdesign.org/).
5+
In this hub, you will find the draft specification for our [Web Sustainability Guidelines](https://w3c.github.io/sustyweb/) and any supplementary documentation, including our [at-a-glance](https://w3c.github.io/sustyweb/glance.html) overview, our [quick reference](https://w3c.github.io/sustyweb/quickref.html), our [PDF checklist](https://w3c.github.io/sustyweb/checklist.pdf), and our [JSON API](https://w3c.github.io/sustyweb/guidelines.json). We also have a living implementation of the specification under active development called [Sustainable Web Design](https://sustainablewebdesign.org/).
66

7-
If you would like a brief introduction to both our group and our specification, you may find [the slides](https://w3c.github.io/sustyweb/TPAC_Slides.pdf) from the presentation we gave at [TPAC 2023](https://www.w3.org/2023/09/breakouts/recording-32.html) useful.
7+
If you would like a brief introduction to both our group and our specification, you may find [the slides](https://w3c.github.io/sustyweb/TPAC_Slides.pdf) from the presentation we gave at [TPAC 2023](https://www.w3.org/2023/09/breakouts/recording-32.html) useful. To learn more about our group, its goals, and our progress, check out our [wiki](https://www.w3.org/community/sustyweb/wiki/Main_Page), and [frequently asked questions](https://www.w3.org/community/sustyweb/wiki/Frequently_Asked_Questions) page.
88

9-
If you would like to contribute feedback, create a [new issue](https://github.com/w3c/sustyweb/issues) with your recommendations. If filing issues in GitHub is not feasible, email our open discussion group [public-sustyweb@w3.org](public-sustyweb@w3.org) ([comment archive](https://lists.w3.org/Archives/Public/public-sustyweb/)). We are currently not accepting Pull Requests (PR's) [at this time](https://github.com/w3c/sustyweb/issues/16), however, we will be publishing guidance shortly for individuals who wish to actively contribute to new features of the upcoming draft.
9+
---
1010

11-
To learn more about our group, its goals, and our progress, check out our [wiki](https://www.w3.org/community/sustyweb/wiki/Main_Page), and [frequently asked questions](https://www.w3.org/community/sustyweb/wiki/Frequently_Asked_Questions) page.
11+
## Contributing
12+
13+
If you would like to contribute feedback, the preferred method is to create a [new issue](https://github.com/w3c/sustyweb/issues) with your comments. You could provide comments on technical errors (bugs) you have uncovered, new guidelines or success criteria you believe should be added, questions you have about existing or future content, or an idea for a direction or feature we could utilize.
14+
15+
Please check that your question hasn't already been posted first, and provide as much detail as possible (if you have a solution or content to add, it would be very helpful). We're all volunteers so please keep this in mind and try to be civil when commenting about our work.
16+
17+
We are now allowing pull requests (PR's) on our repository, however, due to the W3C formatting specification we use (ReSpec), our need to heavily moderate contributions for content quality, and our internal review processes (this is a specification after all), any requests will have their changes vetted against a local copy until approved and then will be merged into the main document at the next release schedule.
18+
19+
If filing issues in GitHub is not feasible, email our open discussion group [public-sustyweb@w3.org](public-sustyweb@w3.org) ([comment archive](https://lists.w3.org/Archives/Public/public-sustyweb/)).
20+
21+
All contributors will receive credit (in the specification and our GitHub release notes) if their feedback and ideas make it into the document.
22+
23+
---
24+
25+
## JSON API
26+
27+
We have a [JSON API](https://w3c.github.io/sustyweb/guidelines.json) which is kept in sync with the changes occurring within our specification.
28+
29+
This document is reachable via GitHub pages and can be queried using JavaScript to embed our data within your client of choice.
30+
31+
The structure of the API is identical to that of the specification in its numbering scheme:
32+
33+
`category[1][0].guideline = "Undertake Systemic Impacts Mapping"`

0 commit comments

Comments
 (0)