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

Backport "refactor(docs): update the contributing docs" to LTS #18960

Merged
merged 1 commit into from
Nov 20, 2023

Conversation

Kordyjan
Copy link
Contributor

Backports #17585 to the LTS branch.

PR submitted by the release tooling.

This makes a bunch of small updates the contributing docs that were
recently migrated over from the scala-lang site. I think there are
actually some more updates to be done, but much of these changes are
just structural. To sort of summarize this does the following:

- gets rid of old irrelevant things like the `checklist.sh`
- removes some instructions that are no longer relevant
- re-organizes the side bar to better group things by topic
- gets rid of redundant information and tries to group things better
- moves the scaladoc docs into the contributing docs

I'll add some more comments inline to further explain.

[skip community_build]

_Old sidebar_

<img width="321" alt="Screenshot 2023-05-25 at 15 18 32"
src="https://github.com/lampepfl/dotty/assets/13974112/2e493110-8098-445c-b101-166998c7c95f">

_New sidebar_
<img width="321" alt="Screenshot 2023-05-25 at 15 18 03"
src="https://github.com/lampepfl/dotty/assets/13974112/2f86764e-bc3e-4356-9f56-006197a10153">
[Cherry-picked 28915c4]
Base automatically changed from lts-17600 to release-3.3.2 November 20, 2023 14:06
@Kordyjan
Copy link
Contributor Author

@Kordyjan Kordyjan merged commit e0ab663 into release-3.3.2 Nov 20, 2023
33 checks passed
@Kordyjan Kordyjan deleted the lts-17585 branch November 20, 2023 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants