Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): one click "add example" button #144

Open
mesqueeb opened this issue Sep 14, 2020 · 7 comments
Open

feat(docs): one click "add example" button #144

mesqueeb opened this issue Sep 14, 2020 · 7 comments
Labels
docs Related to the docs feature Add new features

Comments

@mesqueeb
Copy link
Contributor

mesqueeb commented Sep 14, 2020

馃崺 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:
image

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:


Screenshot 2020-09-14 at 19 12 47


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
Copy link
Owner

millsp commented Sep 14, 2020

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
Copy link
Owner

millsp commented Sep 14, 2020

Thanks for your help

@millsp millsp added the feature Add new features label Sep 14, 2020
@mesqueeb
Copy link
Contributor Author

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

@millsp
Copy link
Owner

millsp commented Sep 14, 2020

Yeah, for us react guys there's docusaurus 馃

@millsp millsp added the docs Related to the docs label Sep 14, 2020
@stale
Copy link

stale bot commented Nov 14, 2020

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.

@stale stale bot added the wontfix This will not be worked on label Nov 14, 2020
@millsp millsp removed the wontfix This will not be worked on label Nov 14, 2020
@stale stale bot added the wontfix This will not be worked on label Jan 14, 2021
Repository owner deleted a comment from stale bot Jan 14, 2021
@stale stale bot removed the wontfix This will not be worked on label Jan 14, 2021
@stale
Copy link

stale bot commented Mar 19, 2021

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.

@stale stale bot added the wontfix This will not be worked on label Mar 19, 2021
@stale stale bot closed this as completed May 10, 2021
@millsp millsp reopened this May 26, 2021
@stale stale bot removed the wontfix This will not be worked on label May 26, 2021
@stale
Copy link

stale bot commented Jul 30, 2021

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.

@stale stale bot added the wontfix This will not be worked on label Jul 30, 2021
@stale stale bot closed this as completed Aug 18, 2021
@millsp millsp reopened this Sep 3, 2021
@stale stale bot removed the wontfix This will not be worked on label Sep 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to the docs feature Add new features
Projects
None yet
Development

No branches or pull requests

2 participants