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

[docs] Improve the design documentation to allow the the iteration on the project. #128

Open
2 of 6 tasks
jpower432 opened this issue Jan 20, 2023 · 0 comments
Open
2 of 6 tasks
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jpower432
Copy link
Contributor

jpower432 commented Jan 20, 2023

What is the problem you're trying to solve
The design documentation needs to be updated and improve with the addition of diagrams and how to use certain types. It also need information on overall design, scope, and goals, of the CLI.

Describe the solution you'd like
Update the documentation

Additional context
Outcomes - Add enough design information to help new contributor get started.

Acceptance Criteria

  • Normalize attribution statement and comments
  • Frame emporous-go as a opinionated authoring tools for publishing information into the UOR data model
  • Update the collection-spec with the new data model @afflom
  • Point documentation to new collection spec
  • High-level design in docs
  • Add package level README.md for types and methods In Progress
@jpower432 jpower432 added the documentation Improvements or additions to documentation label Jan 20, 2023
@jpower432 jpower432 self-assigned this Jan 20, 2023
@jpower432 jpower432 added this to the v0.5.0 milestone Oct 2, 2023
@jpower432 jpower432 changed the title [DOCS] Improve the design documentation [docs] Improve the design documentation to allow the the iteration on the project. Oct 2, 2023
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
Status: In Progress
Development

No branches or pull requests

1 participant