Added support for markdown-autodocs

[dineshsonachalam]

Problem with updating Code block or Markdown tables in your README.md

To make your repo more appealing and, useful you need to provide example code snippets in your README.md. Manually copy and pasting each code snippet or adding a table row in their respective places in your README would be inefficient and time-consuming.

Solution to this problem:

This problem can be solved using markdown-autodocs GitHub Action that is created by me that automatically generates & updates markdown content (like your README.md) from external or remote files. You need to add markers in your README.md that will tell markdown-autodocs where to insert the code snippet or transform JSON to HTML table.

Markdown Autodocs GitHub action: https://github.com/dineshsonachalam/markdown-autodocs

To test or experiment markdown-autodocs without Github action: https://github.com/dineshsonachalam/markdown-autodocs#local-usage-without-github-action

Please let me know if any changes are required and will be happy to help.

[facebook-github-bot]

Hi @dineshsonachalam!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

[cooperlees]

Sweet - This sounds good to me. This will help people get started with fbzmq.

I will state tho, in the next 6 months we'll probably stop using this internally and this will move to a Facebook Archived repo. That means someone will need to fork it to keep it alive as folly and other dependencies keep trucking forward!

[cooperlees]

I would have expected your CI to run here ... Wonder why it is not. Any idea?

[dineshsonachalam]

I would have expected your CI to run here ... Wonder why it is not. Any idea?

Hi @cooperlees,

I'm a first-time contributor to this repo. As per the GitHub actions, first-time contributors need a maintainer to approve running workflows.

I would be very happy if my pull request is accepted. Please let me know if you have any questions.

Thanks,
Dinesh