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

Updated internal documentation #97

Merged
merged 1 commit into from
Dec 20, 2023
Merged

Updated internal documentation #97

merged 1 commit into from
Dec 20, 2023

Conversation

wycats
Copy link
Member

@wycats wycats commented Apr 19, 2023

This commit continues the process of documenting the core Starbeam concepts for contributor consumption, using the package READMEs to document the APIs of the individual packages.

This factoring is not designed for application developers, but it's a perfect place to outline the structure of the concepts from the perspective of someone trying to understand how the codebase is structured.

@stackblitz
Copy link

stackblitz bot commented Apr 19, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@wycats wycats enabled auto-merge April 19, 2023 23:50
@wycats wycats added this pull request to the merge queue Apr 19, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Apr 20, 2023
NullVoxPopuli
NullVoxPopuli previously approved these changes Apr 20, 2023
Copy link
Contributor

@NullVoxPopuli NullVoxPopuli left a comment

Choose a reason for hiding this comment

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

nice work! great to see these improvements!

@wycats wycats added this pull request to the merge queue Apr 20, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Apr 20, 2023
@NullVoxPopuli NullVoxPopuli added this pull request to the merge queue Aug 5, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Aug 5, 2023
@wycats wycats force-pushed the docs/internal-readmes branch 2 times, most recently from af986f2 to fd9078a Compare December 20, 2023 22:26
This commit continues the process of documenting the core Starbeam
concepts for contributor consumption, using the package READMEs to
document the APIs of the individual packages.

This factoring is not designed for application developers, but it's
a perfect place to outline the structure of the concepts from the
perspective of someone trying to understand how the codebase is
structured.
@wycats wycats force-pushed the docs/internal-readmes branch from fd9078a to e268fa1 Compare December 20, 2023 22:28
@wycats wycats merged commit 0ad7df5 into main Dec 20, 2023
8 checks passed
@wycats wycats deleted the docs/internal-readmes branch December 20, 2023 22:34
@NullVoxPopuli NullVoxPopuli added the documentation Improvements or additions to documentation label Jan 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants