Skip to content

Commit 62cf6a4

Browse files
committed
rename README.md to index.md, to avoid broken link alerts
mdbook renders README.md files as index.html, so linking to README.md results in 404 errors.
1 parent ccda270 commit 62cf6a4

File tree

24 files changed

+24
-24
lines changed

24 files changed

+24
-24
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,12 @@ First, please send a PR to add your team to the [`repos/rust-lang/rust-forge.tom
7272
To add your team to the book, add it to [`src/SUMMARY.md`], like below, replacing `<TEAM_NAME>` with a filesystem- and URL-friendly version of your team's name:
7373

7474
```markdown
75-
- [<TEAM NAME>](src/<TEAM_NAME>/README.md)
75+
- [<TEAM NAME>](src/<TEAM_NAME>/index.md)
7676
```
7777

7878
If you run `mdbook build`, `mdbook` will automatically create the folder and file for your team.
7979

80-
It's recommended that you put general team information in `src/<TEAM_NAME>/README.md`, such as where the meetings happen, repositories that the team manages, links to chat platforms, etc. Larger topics should be made as a subpage, e.g. (`src/release/topic.md`).
80+
It's recommended that you put general team information in `src/<TEAM_NAME>/index.md`, such as where the meetings happen, repositories that the team manages, links to chat platforms, etc. Larger topics should be made as a subpage, e.g. (`src/release/topic.md`).
8181

8282
```markdown
8383
- [TOPIC](src/<TEAM_NAME>/TOPIC.md)

src/SUMMARY.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Rust Forge
22

3-
[Overview](./README.md)
3+
[Overview](./index.md)
44
- [How to start contributing](./how-to-start-contributing.md)
55
- [Onboarding to the project](./onboarding.md)
6-
- [Platforms](./platforms/README.md)
6+
- [Platforms](./platforms/index.md)
77
- [Twitter](./platforms/twitter.md)
88
- [Discord](./platforms/discord.md)
99
- [Email](./platforms/email.md)
@@ -12,7 +12,7 @@
1212
- [Moderation](./platforms/zulip/moderation.md)
1313
- [Blogs](./platforms/blogs.md)
1414
- [Calendars](./platforms/calendars.md)
15-
- [Triagebot](./triagebot/README.md)
15+
- [Triagebot](./triagebot/index.md)
1616
- [Agenda Generator](./triagebot/agenda.md)
1717
- [Issue Assignment](./triagebot/issue-assignment.md)
1818
- [PR Assignment](./triagebot/pr-assignment.md)
@@ -47,8 +47,8 @@
4747
- [Zulip Meeting Management](./triagebot/zulip-meeting.md)
4848
- [Zulip Notifications](./triagebot/zulip-notifications.md)
4949
- [GitHub Actions created PR open/closer](./triagebot/bot-pull-requests.md)
50-
- [Community](./community/README.md)
51-
- [Compiler](./compiler/README.md)
50+
- [Community](./community/index.md)
51+
- [Compiler](./compiler/index.md)
5252
- [Calendar](./compiler/calendar.md)
5353
- [Cross-team Collaboration](./compiler/cross-team-collaboration.md)
5454
- [Meetings](./compiler/meetings.md)
@@ -64,32 +64,32 @@
6464
- [Triage and Prioritization](./compiler/prioritization.md)
6565
- [Working Areas](./compiler/working-areas.md)
6666
- [Operations](./compiler/operations.md)
67-
- [rustc-dev-guide](./wg-rustc-dev-guide/README.md)
68-
- [crates.io](./crates-io/README.md)
67+
- [rustc-dev-guide](./wg-rustc-dev-guide/index.md)
68+
- [crates.io](./crates-io/index.md)
6969
- [Crate removal](./crates-io/crate-removal.md)
7070
- [Database maintenance](./crates-io/db-maintenance.md)
71-
- [docs.rs](./docs-rs/README.md)
71+
- [docs.rs](./docs-rs/index.md)
7272
- [Adding dependencies to the build environment](./docs-rs/add-dependencies.md)
7373
- [Self-hosting a docs.rs instance](./docs-rs/self-hosting.md)
7474
- [Maintenance procedures](./docs-rs/maintenance.md)
75-
- [Governance](./governance/README.md)
75+
- [Governance](./governance/index.md)
7676
- [Leadership Council](./governance/council.md)
7777
- [Moderation](./governance/moderation.md)
7878
- [Project groups](./governance/project-groups.md)
79-
- [Policies](./policies/README.md)
79+
- [Policies](./policies/index.md)
8080
- [Crate ownership policy](./policies/crate-ownership.md)
81-
- [Infrastructure](./infra/README.md)
81+
- [Infrastructure](./infra/index.md)
8282
- [Other Installation Methods](./infra/other-installation-methods.md)
8383
- [Archive of Rust Stable Standalone Installers](./infra/archive-stable-version-installers.md)
8484
- [Release Channel Layout](./infra/channel-layout.md)
8585
- [Service Infrastructure](./infra/service-infrastructure.md)
8686
- [Team Maintenance](./infra/team-maintenance.md)
8787
- [The Toolstate System](./infra/toolstate.md)
88-
- [Policies](./infra/policies/README.md)
88+
- [Policies](./infra/policies/index.md)
8989
- [Broken nightlies](./infra/policies/broken-nightlies.md)
90-
- [Guidelines](./infra/guidelines/README.md)
90+
- [Guidelines](./infra/guidelines/index.md)
9191
- [Static websites](./infra/guidelines/static-websites.md)
92-
- [Documentation](./infra/docs/README.md)
92+
- [Documentation](./infra/docs/index.md)
9393
- [AWS access for team members](./infra/docs/aws-access.md)
9494
- [AWS access management](./infra/docs/aws-access-management.md)
9595
- [AWS regions](./infra/docs/aws-regions.md)
@@ -108,13 +108,13 @@
108108
- [rust-bots server](./infra/docs/rust-bots.md)
109109
- [rust-lang/rust CI](./infra/docs/rustc-ci.md)
110110
- [Sentry](./infra/docs/sentry.md)
111-
- [Language](./lang/README.md)
111+
- [Language](./lang/index.md)
112112
- [RFC Merge Procedure](./lang/rfc-merge-procedure.md)
113113
- [Triage Meeting Procedure](./lang/triage-meeting-procedure.md)
114114
- [Stabilization procedure](./lang/stabilization-procedure.md)
115-
- [Libs](./libs/README.md)
115+
- [Libs](./libs/index.md)
116116
- [Maintaining the standard library](./libs/maintaining-std.md)
117-
- [Release](./release/README.md)
117+
- [Release](./release/index.md)
118118
- [Backporting](./release/backporting.md)
119119
- [Preparing Release Notes](./release/release-notes.md)
120120
- [Release Process](./release/process.md)
@@ -123,6 +123,6 @@
123123
- [Issue Triaging](./release/issue-triaging.md)
124124
- [Triaging Crater Runs](./release/crater.md)
125125
- [Edition Releases](./editions/edition-releases.md)
126-
- [Archive](./archive/README.md)
126+
- [Archive](./archive/index.md)
127127
- [Friends of the Tree](./archive/fott.md)
128128
- [Release History](./archive/release-history.md)
File renamed without changes.
File renamed without changes.

src/compiler/backports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ stable point release.
6868

6969
## How are approved backports handled?
7070

71-
The [release team](../release/README.md) (`T-release`) will handle the backport at the end of the
71+
The [release team](../release/index.md) (`T-release`) will handle the backport at the end of the
7272
current development cycle (see [release backporting](../release/backporting.md)). If a beta backport
7373
nomination is approved too late, the release team may be unable to backport the change.
7474

File renamed without changes.

src/compiler/membership.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This team discusses membership in the compiler team. There are currently two lev
55
* maintainers: members who have committed themselves to invest in the quality of the compiler and
66
health of the compiler team
77

8-
[infrastructure]: ../infra/README.md
8+
[infrastructure]: ../infra/index.md
99

1010
## The path to membership
1111
People who are looking to contribute to the compiler typically start in one of two ways. They may
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

src/infra/service-infrastructure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Documentation on rfcbot commands can be found
4949
[rustbot](https://github.com/rust-lang/triagebot) is a bot ([bot user
5050
account](https://github.com/rustbot)) to assist with managing issues and PRs
5151
to allow users to label and assign without GitHub permissions. See
52-
[triagebot](../triagebot) for more information.
52+
[triagebot](../triagebot/index.md) for more information.
5353

5454
## DXR
5555

src/infra/toolstate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,4 +108,4 @@ To add a new tool to be tracked, the following steps must be taken:
108108
[subup]: https://github.com/ehuss/subup
109109
[toolstate]: https://rust-lang-nursery.github.io/rust-toolstate/
110110
[toolstate repository]: https://github.com/rust-lang-nursery/rust-toolstate/
111-
[forge]: ../README.md
111+
[forge]: ../index.md
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)