docute icon indicating copy to clipboard operation
docute copied to clipboard

Versioned docs

Open marvinroger opened this issue 7 years ago • 8 comments

There could be some sort of version picker that would show all available tags on the repo (with a regex pattern for example) and show the according docs. That would be great!

marvinroger avatar Jun 08 '17 17:06 marvinroger

Does something like this work for you?

2017-06-09 1 29 16

http://vuejs.github.io/rollup-plugin-vue/#/en/2.3/

egoist avatar Jun 09 '17 05:06 egoist

It would, but having to duplicate the previous docs just does not feel right! If you have a rather large docs with pictures, it would quickly fill up the git repo.

marvinroger avatar Jun 09 '17 06:06 marvinroger

Hmm, I don't understand what you mean, I think docs for different versions can share assets like images, nothing is really duplicated.

egoist avatar Jun 09 '17 07:06 egoist

That's right, we can share the assets. But still, the markdown files would be duplicated, as we have to create a new folder each time we release a new version.

Here's how I envision it:

  • Docute would fetch the list of tag for the repo: https://api.github.com/repos/egoist/docute/tags
  • It would then show a picker with each tag corresponding to a regex pattern (semver for example)
  • It would then fetch the corresponding files via GitHub, e.g. for v2.9.3: https://raw.githubusercontent.com/egoist/docute/v2.9.3/docs/README.md

It's just an idea, I understand if you would not want to go in that direction.

marvinroger avatar Jun 09 '17 07:06 marvinroger

gotcha, that makes sense to me, I will try to implement this in the weekend

egoist avatar Jun 09 '17 08:06 egoist

Hey @egoist . Great job with Docute.

Just wondering if there's been any update on this?

Cheers.

ezra-obiwale avatar Nov 14 '17 17:11 ezra-obiwale

I'd like this functionality as well! @egoist have you made any progress on it? Do we agree on @marvinroger approach?

markadrake avatar Dec 06 '17 04:12 markadrake

@markadrake not yet, but thesource option could be a workaound https://docute.js.org/#/home?id=custom-source

egoist avatar Dec 06 '17 04:12 egoist

Cleaning up my issues, and I see that this project is not maintained anymore, genuine thanks for all your awesome projects @egoist!

marvinroger avatar Nov 16 '22 11:11 marvinroger