This week began with a productive meeting with my mentor Aman, where I showcased the components I’ve implemented so far — the Shift Register, Comparator, and Pull Resistor.
We also discussed the versioning issue I’ve been facing. This has been a blocker for me since I haven't been able to raise a PR for my work because of it.
To make good use of time while the issue is being resolved, we decided to focus on writing documentation for the components I’ve already completed.
I first looked at how documentation is written for the existing components. Most of them follow a standard structure:
- - A description of the component
- - A list of its ports
- - An example
- - An embedded circuit showing how it works
At first, I thought writing the docs would be easy. But I soon realized —
simple isn’t always easy.
The problem? I couldn’t embed my circuit examples in the documentation because the components haven’t been merged yet due to the versioning issue.
For now, I’ve created the example circuits on my local machine. Once the components are merged, I’ll update the links in the docs to include the live embedded circuits.
Hoping the versioning issue will be solved in the upcoming week so that tasks dependent on each other can finally be marked as completed.