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

Update docs enough for new dev onboarding #649

Merged
merged 23 commits into from
Oct 3, 2023
Merged

Update docs enough for new dev onboarding #649

merged 23 commits into from
Oct 3, 2023

Conversation

n8kim1
Copy link
Contributor

@n8kim1 n8kim1 commented Jun 11, 2023

While there's still much more to write...
This PR updates our docs for onboarding. In particular, the goals are:

  • Nothing in the docs is actively wrong (untruthful, misleading, old, obsolete, etc)
  • The original frontend docs are all ported to new places (or just deleted if obsolete)
  • Enough of an outline is present so that during onboarding, if someone takes notes, they can easily slot those notes into a fitting place

Note: Some filenames and paths will have to be rewritten once frontend2 becomes frontend; I'll cross that bridge when we get to it.

Starts addressing #49

@n8kim1 n8kim1 marked this pull request as draft June 11, 2023 19:18
@n8kim1 n8kim1 changed the base branch from main to frontend2 September 26, 2023 19:25
@n8kim1 n8kim1 changed the title Update docs Update docs enough for new dev onboarding Sep 26, 2023
Copy link
Member

@acrantel acrantel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for doing this! I put down two comments
I think we can say that Github issues and roadmap are both places to find TODOs. Roadmap has some TODOs that are not listed in issues, and some Github issues are not listed in Roadmap. I'm planning on listing issues in the roadmap when we decide to prioritize them.

frontend2/docs/onboard.md Outdated Show resolved Hide resolved
docs-general/workflow.md Outdated Show resolved Hide resolved
@acrantel
Copy link
Member

Also I see this PR is still listed as draft - is it ready to merge?

@n8kim1 n8kim1 marked this pull request as ready for review October 3, 2023 16:37
@n8kim1 n8kim1 requested a review from acrantel October 3, 2023 16:37
@n8kim1
Copy link
Contributor Author

n8kim1 commented Oct 3, 2023

@acrantel ready for review!

frontend2/docs/onboard.md Outdated Show resolved Hide resolved
Copy link
Member

@acrantel acrantel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one comment to delete the jquery section but otherwise this is good to merge

@n8kim1 n8kim1 merged commit 8f2c90d into frontend2 Oct 3, 2023
3 checks passed
@n8kim1 n8kim1 deleted the docs branch October 3, 2023 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants