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

Documentation for Embedded mode #689

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Documentation for Embedded mode #689

wants to merge 2 commits into from

Conversation

itdnk
Copy link
Contributor

@itdnk itdnk commented Aug 1, 2023

Initial revision for embedded mode documentation.

Initial revision for embedded mode documentation.
@itdnk itdnk requested a review from a team as a code owner August 1, 2023 18:06
@github-actions
Copy link

github-actions bot commented Aug 1, 2023

Test Results

107 files  107 suites   5m 12s ⏱️
548 tests 547 ✔️ 1 💤 0

Results for commit 9f32d9e.

♻️ This comment has been updated with latest results.

@kevin-m-knight-gs kevin-m-knight-gs marked this pull request as draft August 2, 2023 15:35
Copy link
Contributor

@kevin-m-knight-gs kevin-m-knight-gs left a comment

Choose a reason for hiding this comment

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

I don't think this document actually provides a definition of embedded mode. I would expect a definition of embedded mode to discuss things like project configuration, project structure, what other modes there are, and how embedded mode differs from them. But I do not see any of that.

Most of it seems to be generically about why someone might use Legend. I think you can assume that anyone looking at this document already has this context.

Also, maybe this file should be in a docs directory, rather than at the root.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants