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

Update design documentation #274

Closed
mchack-work opened this issue Oct 14, 2024 · 0 comments · Fixed by #281
Closed

Update design documentation #274

mchack-work opened this issue Oct 14, 2024 · 0 comments · Fixed by #281
Assignees
@mchack-work
Labels
documentation Improvements or additions to documentation

Comments

@mchack-work
Copy link
Member

We decided on a policy of using README files close to the code for software and hardware design documentation. This has been partly done but isn't complete.

  • Remove old documentation under doc/system_description.
  • Move and/or write README, especially a high-level README for the application_fpga design.
@mchack-work mchack-work self-assigned this Oct 14, 2024
@mchack-work mchack-work added the documentation Improvements or additions to documentation label Oct 14, 2024
@mchack-work mchack-work mentioned this issue Oct 14, 2024
Merged
4 tasks
@mchack-work mchack-work changed the title Update documentation Update design documentation Oct 14, 2024
@dehanj dehanj linked a pull request Nov 11, 2024 that will close this issue
Revise docs #281
Merged
12 tasks
@dehanj dehanj mentioned this issue Nov 11, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mchack-work mchack-work

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

Successfully merging a pull request may close this issue.

Revise docs tillitis/tillitis-key1
1 participant
@mchack-work