search

lightninglabs / lightning-api-ng

Automated API-documentation generation source code for Lightning Lab's FOSS software suite
6 stars 7 forks source link

Port Typescript markdown generator to golang #9

Closed jamaljsr closed 1 year ago

jamaljsr commented 1 year ago

Closes #6

I've refactored and updated the merger tool to include the functionality of the Typescript generate-docs script. It will now generate the markdown docs file directly without the need for the intermediary JSON files.

Steps to Test

  1. Run ./generate.sh in the repo root dir
  2. Run yarn start in the site dir
jamaljsr commented 1 year ago

@guggero I'd like to get your feedback on the overall implementation. I'm not sure of the best structure for packages and files in a golang CLI app. I can't say I'm thrilled with the results. I basically mimicked most of the TS code. Please be as critical as you'd like, I'm really looking to learn best practices in this stack.

FYI: The commits are a bit of a mess as I was figuring things out as I went along. I don't mind rewriting them if it'll make review easier on you. I figured I'd just push up what I have so far in case major refactorings were needed and I'd need to restructure the commits again.

lightninglabs-deploy commented 1 year ago

@jamaljsr, remember to re-request review from reviewers when ready

jamaljsr commented 1 year ago

Thanks again for the review. This feedback is super helpful. 🙏

I made all of the updates based on your prior feedback. I also rewrote all of the commits to address the tabs, spaces, line columns, and comments. It should be much easier to step through since each commit compiles and runs successfully.

jamaljsr commented 1 year ago

Thanks so much for the review. I've addressed all of your latest feedback. I think this should be good to go now.