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.

Sign up for GitHub

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

Jump to bottom

docs: Description of jenny package #2102

Merged
merged 27 commits into from
Dec 16, 2022
Merged

docs: Description of jenny package #2102

merged 27 commits into from
Dec 16, 2022

Conversation

st-pasha
Copy link
Contributor

@st-pasha st-pasha commented Oct 21, 2022 •
edited
Loading

Description

Adding preliminary description for the jenny project.

Checklist

  • The title of my PR starts with a Conventional Commit prefix (fix:, feat:, docs: etc).
  • I have followed the Contributor Guide when preparing my PR.
  • I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • [-] I have updated/added relevant examples in examples or docs.

Breaking Change?

  • [-] Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

@st-pasha st-pasha mentioned this pull request Oct 23, 2022
Merged
4 tasks
spydon pushed a commit that referenced this pull request Nov 5, 2022
@st-pasha
feat: DialogueRunner for jenny (#2113)
5ba6ff2 
The DialogueRunner is the engine that actually runs the dialogue.

Note: documentation will be added in PR #2102.
spydon
spydon approved these changes Dec 10, 2022
View reviewed changes
Copy link
Member

@spydon spydon left a comment

Choose a reason for hiding this comment

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

Very well written docs, good job!

doc/bridge_packages/flame_isolate/isolate.md Outdated Show resolved Hide resolved
doc/other_modules/jenny/yarn_project.md Outdated Show resolved Hide resolved
@st-pasha st-pasha marked this pull request as ready for review December 14, 2022 07:53
@st-pasha st-pasha changed the title docs: Description of flame_yarn package docs: Description of jenny package Dec 14, 2022
@st-pasha st-pasha added jenny Issues/PRs related to the Jenny package documentation labels Dec 14, 2022
@spydon spydon requested a review from a team December 14, 2022 09:23
luanpotter
luanpotter reviewed Dec 14, 2022
View reviewed changes
doc/other_modules/jenny/language/commands/commands.md
@@ -0,0 +1,16 @@
# Commands

The **commands** are special instructions surrounded with double angle-brackets: `<<stop>>`. There
Copy link
Member

Choose a reason for hiding this comment

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

isn't this part of the jenny spec that we can link to? or is this specific to our port?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are still some parts of the documentation missing, I'm planning to add them in later PRs, since this one became too big already.

YarnSpinner docs have a section about commands (https://docs.yarnspinner.dev/getting-started/writing-in-yarn/commands), but for some reason they only document 2 of them.

luanpotter
luanpotter reviewed Dec 14, 2022
View reviewed changes
Copy link
Member

@luanpotter luanpotter left a comment

Choose a reason for hiding this comment

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

This is a big PR that seems to be bundling several different, unrelated changes; I think it would be easier to review in the future with separated PRs for each change

luanpotter
luanpotter approved these changes Dec 16, 2022
View reviewed changes
Copy link
Member

@luanpotter luanpotter left a comment

Choose a reason for hiding this comment

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

LGTM

@spydon spydon merged commit a99c930 into main Dec 16, 2022
@spydon spydon deleted the ps.flame-yarn-docs branch December 16, 2022 06:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spydon spydon spydon approved these changes

@luanpotter luanpotter luanpotter approved these changes

Assignees
No one assigned
Labels
documentation jenny Issues/PRs related to the Jenny package
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@st-pasha @spydon @luanpotter