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

[CHORE] Commit start of a Developer Guide #4237

Closed
wants to merge 1 commit into from
Closed

Conversation

rix0rrr
Copy link
Collaborator

@rix0rrr rix0rrr commented Apr 16, 2023

Since more and more different people work on and contribute to Hedy, expecting new people to absorb architectural decisions from the existing code is not tenable.

This change adds a start for a developer guide with content to guide future implementors.

I'd love suggestions for content to cover here.

Since more and more different people work on and contribute to Hedy,
expecting new people to absorb architectural decisions from the existing
code is not tenable.

This change adds a start for a developer guide with content to guide
future implementors.
@ghost
Copy link

ghost commented Apr 16, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@Felienne
Copy link
Member

Felienne commented Apr 17, 2023

Thanks for this @rix0rrr!!

I have moved most of your content to the wiki (see https://github.com/hedyorg/hedy/wiki/Hedy-Developer-Guide).

A few reasons I think this fits best in a wiki:

  • Easier to navigate than one long document (newcomers already often don't reach the end of CONTRUBUTING.MD)
  • Easier to edit/organize
  • Saves PRs/approvals
  • Centres the "why" of Hedy (in the main wiki page), encourages people to also read and think about what we are building rather than only how

@Felienne Felienne closed this Apr 17, 2023
@Felienne Felienne deleted the developer-guide branch November 23, 2023 20:27
@Felienne Felienne restored the developer-guide branch November 23, 2023 20:27
@Felienne Felienne deleted the developer-guide branch November 23, 2023 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants