Ts-toolbelt: feat(docs): one click "add example" button

[mesqueeb]

🍩 Feature Request

Teachability, Documentation, Adoption, Migration Strategy

In the documentation, there is often a case where I find the example lacking and would like to suggest a new example or add one where there is none.

Currently there's a link like so:

However, the problem is that this opens the page at a specific blob like this link:
https://github.com/millsp/ts-toolbelt/blob/3859d18/src/Any/Compute.ts#L48

From here it's pretty complicated how I can easily make a change and open a PR.

With other sites that use eg. Vue Press, you'll get this "edit these docs" link like so:

---

---

Which, if you don't have a fork, will automatically create a fork and prompt to open a PR after a change.

Maybe you could slightly make this adjustment to the links you added to your examples so it does the same?

[millsp]

Definitely! I was needing to move the website to .md files but I got too busy lately. I though I'd move to docz but I'm not sure if they have such a feature for editing. Don't hesitate to share a list of doc generators you like.

[millsp]

Thanks for your help

[mesqueeb]

Well, I like Vue Press, but I know you're a React guy, so we're kinda in different camps here 😛

[millsp]

Yeah, for us react guys there's docusaurus :t-rex:

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.