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

doc(facade/PC): add README #5123

Merged
merged 5 commits into from
Jul 31, 2023
Merged

doc(facade/PC): add README #5123

merged 5 commits into from
Jul 31, 2023

Conversation

skaldarnar
Copy link
Member

@skaldarnar skaldarnar commented Jul 18, 2023

Contains

Add a README for the PC Facade explaining basic usage and architecture.

Based on the discussion on Document Execution Flows in the Engine on Discord.

How to test

n/a

Give it a good read and let me know about anything that sounds off or leaves open questions.

Outstanding before merging

n/a

@github-actions github-actions bot added the Category: Doc Requests, Issues and Changes targeting javadoc and module documentation label Jul 18, 2023
facades/PC/README.md Outdated Show resolved Hide resolved
@skaldarnar skaldarnar added this to the 2023 Revive - Milestone 1 milestone Jul 18, 2023
@skaldarnar skaldarnar force-pushed the doc/pc-facade branch 6 times, most recently from 31e7cdb to bbeaaa9 Compare July 18, 2023 20:59
Copy link
Contributor

@BenjaminAmos BenjaminAmos left a comment

Choose a reason for hiding this comment

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

This explains things well but there are a few typos in places.

facades/PC/README.md Outdated Show resolved Hide resolved
facades/PC/README.md Outdated Show resolved Hide resolved
facades/PC/README.md Outdated Show resolved Hide resolved
facades/PC/README.md Show resolved Hide resolved
facades/PC/README.md Show resolved Hide resolved
facades/PC/README.md Outdated Show resolved Hide resolved
jdrueckert and others added 2 commits July 30, 2023 19:54
Co-authored-by: BenjaminAmos <24301287+BenjaminAmos@users.noreply.github.com>
@jdrueckert jdrueckert merged commit e33518e into develop Jul 31, 2023
9 checks passed
@jdrueckert jdrueckert deleted the doc/pc-facade branch July 31, 2023 18:13
@skaldarnar
Copy link
Member Author

@jdrueckert thanks for taking care of implementing the suggestions and getting this merged 💚

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants