start-os icon indicating copy to clipboard operation
start-os copied to clipboard

[feat]: Local html copy of Embassy Manual

Open PLK2 opened this issue 3 years ago • 7 comments

Prerequisites

  • [X] I have searched for existing issues that already suggest this feature, without success.

Describe the Feature Request

Provide an option to download a copy of the Embassy manual, to be stored locally on the embassy.

Describe the Use Case

For local troubleshooting purposes, in case internet is out or slow or whatever. Also just easier/faster to have it local.

Describe Preferred Solution

No response

Describe Alternatives

No response

Anything else?

No response

PLK2 avatar Jun 09 '22 02:06 PLK2

We have considered this, but it is quite large (or would need to be adapted to a skinnier version). We would love to see a PR for this ;)

kn0wmad avatar Jun 09 '22 16:06 kn0wmad

Yeah, wasn't sure how large it would be. Not critical; I just like to keep manuals offline and adjacent to where they may be needed.

PLK2 avatar Jun 09 '22 17:06 PLK2

Totally agree, it will be nice to have

kn0wmad avatar Jun 09 '22 19:06 kn0wmad

We could put a link to this in the top left where the Start9 icon is

chrisguida avatar Jun 10 '22 14:06 chrisguida

The point of this issue is to have a local copy

kn0wmad avatar Jun 10 '22 14:06 kn0wmad

Yes, I know....

chrisguida avatar Jun 10 '22 15:06 chrisguida

I think the better answer here is to cache a copy of the centralized manual every time you fetch it and then try to update it periodically. Centrally managed docs are going to be more up to date and caching them locally should alleviate concerns about accessibility without Start9's presence.

ProofOfKeags avatar Jun 10 '22 19:06 ProofOfKeags

Fetch the latest compatible version of docs

elvece avatar Dec 14 '22 22:12 elvece

Closing in favor of a "Docs" package

MattDHill avatar Mar 16 '23 17:03 MattDHill

Closed in favor of https://github.com/Start9Labs/docs/issues/4

kn0wmad avatar Mar 16 '23 17:03 kn0wmad