Skip to content

Commit 739266f

Browse files
authored
README: Add links to rendered pages, editorial updates (#373)
This adds links to the rendered HTML pages next to the mentions of the folders so that people can quickly check the contents of the underlying section in the guidebook. Fixes #314. This also fixes a couple of typos and links.
1 parent a725439 commit 739266f

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
The repository for "[The Art of Consensus](https://www.w3.org/guide/)", W3C's Chair's Guidebook.
44

5-
Documentation on how to participate in W3C WGs is split between multiple wikipages, github repos and emails. This means new members find difficulty in finding information as to how to participate and maybe give up trying. This repository is the place to pull all of those
6-
together.
5+
Documentation on how to participate in W3C Working Groups is split between multiple wikipages, github repos and emails. This means new members find difficulty in finding information as to how to participate and maybe give up trying. This repository is the place to pull all of those together.
76

87
## Got a question?
98

@@ -17,38 +16,40 @@ The general edition of the Guidebook is managed by [@w3c/guidebook](https://gith
1716

1817
The Guidebook uses the [W3C Jekyll theme](https://github.com/w3c/w3c-jekyll-theme). See the [README](https://github.com/w3c/w3c-jekyll-theme/blob/main/README.md) to run Jekyll locally.
1918

20-
Note that latest versions of Ruby might created a [dependency issue]([url](https://github.com/jekyll/jekyll/pull/9392)). It is recommended to use the Ruby version mentioned in the [Github workflow]([url](https://github.com/w3c/guide/blob/1a2821f048c40648a9623ac8bd46056991e30b89/.github/workflows/jekyll-gh-pages.yml#L21)).
19+
Note that latest versions of Ruby might create a [dependency issue](https://github.com/jekyll/jekyll/pull/9392). It is recommended to use the Ruby version mentioned in the [Github workflow](https://github.com/w3c/guide/blob/main/.github/workflows/jekyll-gh-pages.yml#L21).
2120

2221
## In this repository
2322

2423
* [/chair/](chair)
25-
* Instructions on how to chair WGs and IGs including managing meetings, setting up the homepage, maintaining the calendar.
24+
* [Resources for Group Chairs](https://www.w3.org/guide/chairs/).
25+
* Instructions on how to chair Working Groups and Interest Groups including managing meetings, setting up the homepage, maintaining the calendar.
2626
* [/council/](council)
27-
* Anything related to councils.
27+
* [Anything related to W3C Councils](https://www.w3.org/guide/chairs/).
2828
* [/documentreview/](documentreview)
29-
* How to do [wide review](https://www.w3.org/guide/documentreview/).
29+
* [How to do wide review](https://www.w3.org/guide/documentreview/).
3030
* [/editor/](editor)
31-
* [W3C Editors' Home Page](https://www.w3.org/guide/editor/).: How to author a specification, including ReSpec or other spec making programs.
31+
* [W3C Editors' Home Page](https://www.w3.org/guide/editor/).
32+
* How to author a specification, including ReSpec or other spec making programs.
3233
* [/github/](github)
33-
* How to use Git and GitHub at W3C.
34+
* How to use [Git and GitHub at W3C](https://www.w3.org/guide/github/).
3435
* [/manual-of-style/](manual-of-style)
3536
* The [W3C Manual of Style](https://www.w3.org/guide/manual-of-style/) for editors.
3637
* [/meetings/](meetings)
37-
* Anything related to organizing meetings, including events.
38+
* [Resources about W3C Meetings](https://www.w3.org/guide/manual-of-style/), including events.
3839
* [/process/](process)
39-
* Anything related to additional guidelines when following the process.
40+
* [Procedures related to the W3C Process](https://www.w3.org/guide/process/).
4041
* You may involve [@w3c/w3process-editors](https://github.com/orgs/w3c/teams/w3process-editors).
4142
* [/process/tilt/](process/tilt)
4243
* Anything related to [technical Team decision and verification](https://www.w3.org/guide/process/tilt/), except for transitions.
4344
* Managed by [@w3c/tilt](https://github.com/orgs/w3c/teams/tilt)
44-
* [/standards-track/](standards-track).
45-
* Best Practices for Bringing Work to the W3C Recommendation Track.
45+
* [/standards-track/](standards-track)
46+
* [Best Practices for Bringing Work to the W3C Recommendation Track](https://www.w3.org/guide/standards-track/).
4647
* [/teamcontact/](teamcontact)
47-
* Guidance on the role of the team contact, and what to expect from them.
48+
* [Guidance on the role of the team contact](https://www.w3.org/guide/teamcontact/), and what to expect from them.
4849
* [/transitions/](transitions)
4950
* [Organize a Technical Report Transition](https://www.w3.org/guide/transitions/).
5051
* Managed by [@w3c/transitions](https://github.com/orgs/w3c/teams/transitions).
5152
* [/other/](other)
52-
* Related to [permanent groups](https://www.w3.org/groups/).
53+
* [Additional guidelines](https://www.w3.org/guide/other/) that do not fit under main categories, notably guidelines related to [permanent groups](https://www.w3.org/groups/).
5354

54-
Note: now that we have a repository for the guidebook, simply add your documentation to it, rather than creating new repositories.
55+
**Note:** now that we have a repository for the guidebook, simply add your documentation to it, rather than creating new repositories.

0 commit comments

Comments
 (0)