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

Improve Documentation and Welcome Message #27

Open
Theophilusbenson opened this issue Dec 8, 2022 · 2 comments
Open

Improve Documentation and Welcome Message #27

Theophilusbenson opened this issue Dec 8, 2022 · 2 comments
Assignees
@Theophilusbenson
Labels
documentation Improvements or additions to documentation

Comments

@Theophilusbenson
Copy link
Member

Currently, the welcome README points viewers to the LPC presentation. We should include a summary and discuss highlilghts.
@Theophilusbenson Theophilusbenson self-assigned this Dec 8, 2022
@sdsen sdsen added the documentation Improvements or additions to documentation label Dec 9, 2022
@sdsen
Copy link
Member

sdsen commented Dec 9, 2022

@Theophilusbenson one suggestion is to create two pages 1. welcome page with broader intro. for need for devtools.
We will move the code to a separate org, and then the welcome will go there.

The documentation improvement for extraction (goals, motivation, who are we building for ..) specifically can stay in this repo.

@sdsen
Copy link
Member

sdsen commented Dec 10, 2022

For documentation, will be good to explain the contents of various artefacts generated in some details. Like structure of the file, implication of fields etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Theophilusbenson Theophilusbenson

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@sdsen @Theophilusbenson