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 Sphinx docs. #5

Open
3 tasks
9600 opened this issue Dec 19, 2022 · 3 comments
Open
3 tasks

Update Sphinx docs. #5

9600 opened this issue Dec 19, 2022 · 3 comments
Assignees
@callumsnowden
Labels
documentation Improvements or additions to documentation

Comments

@9600
Copy link
Member

9600 commented Dec 19, 2022

  • modules/index
  • modules/* (all module pages)
  • ESDK module specification

Main modules page needs updating to add I2C and GPIO details. Where a module uses I2C enter the address. With GPIO enter details of pin(s) used.

All ESDK module pages need updating to add theory of operation, schematic and board plots. Some also need the main header image.

Also need to add details to the module specification page, e.g. dimensions for single and double width, with any design notes such as keep-out areas. Connector, I/O and power spec etc.
@9600 9600 added the documentation Improvements or additions to documentation label Dec 19, 2022
@9600
Copy link
Member Author

9600 commented Dec 20, 2022

Missing a few images:

  • ESDK-EEA.jpg
  • ESDK-Main-schematic.svg
  • ESDK-Main-layout.png

@callumsnowden
Copy link
Contributor

ESDK-EEA images were commited in 283dcff

@callumsnowden
Copy link
Contributor

Fixed typo in ESDK-MAIN image file paths in 84f2092

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

@callumsnowden callumsnowden

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

No branches or pull requests
2 participants
@9600 @callumsnowden