Open BHunter2889 opened 1 year ago
Hi there 👋
@BHunter2889 Thanks for pointing this out! We are planning on doing a rehaul on our documentation in the coming weeks / months, but you pointing this out certainly is most helpful!
If you would like to submit a PR for this you are most welcome to and I will review/approve/merge 😄. If you would prefer otherwise I can go ahead and submit this myself, it's really up to you.
If there's anything big or small you notice in the future, any issue you file and suggestion you make is much appreciated.
Thanks!
Lines ~7-31 of the witness_completion.md doc seem to be incorrectly formatted per GFM: https://github.com/testifysec/witness/blob/602dc485b2b775e6c7cc66b11653a91fdef2aeda/docs/witness_completion.md?plain=1#L7-L31
Screenshot of rendered Preview:
There are a few ways to take care of this but this is perhaps the simplest for what was intended:
Which renders this:
I would put up a PR after raising this, but I'm not sure this constitutes a "meaningful body of work" haha.