Differential D25465

Fix loop in contribution docs
ClosedPublic
Actions

Authored by waldyrious on Nov 11 2023, 11:13.

Details

Reviewers

speck

Group Reviewers

O1: Blessed Committers

Commits

rP296ce3956b81: Fix loop in contribution docs

Summary

The Contributor Introduction lists in the next steps the Contributing Code page;
in its turn, the Contributing Code page links back to the Contributor Introduction page.

This change fixes that infinite loop by adding an actual path forward, adding a link to the Developer Setup page in the Next Steps section of the Contributing Code page.

Test Plan

Open the /book/contrib/article/contributing_code/ URL and confirm that the Developer Setup is included in the Next Steps section.

Diff Detail

Repository

rP Phorge

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

waldyrious created this revision.Nov 11 2023, 11:13

Owners added a reviewer: O1: Blessed Committers.Nov 11 2023, 11:13

Herald added subscribers: Cigaryno, Matthew, valerio.bozzolan, tobiaswiese. · View Herald TranscriptNov 11 2023, 11:13

Harbormaster completed remote builds in B908: Diff 1475.Nov 11 2023, 11:13

waldyrious requested review of this revision.Nov 11 2023, 11:13

waldyrious mentioned this in Z5: Phorge (flame).Nov 11 2023, 11:15

waldyrious edited the summary of this revision. (Show Details)

speck subscribed.Nov 11 2023, 15:48

speck added inline comments.

src/docs/contributor/contributing_code.diviner
197–199	What do you think of the phrasing “getting started with Developer Setup”?

waldyrious added inline comments.Nov 11 2023, 23:58

src/docs/contributor/contributing_code.diviner
197–199	No objection to the general idea, but I'd rather make it more explicit that it's about getting started with development specifically, to disambiguate with the "Contributor Introduction" page linked immediately after. How about "preparing your development environment as described in the Developer Setup"?