caxlsx icon indicating copy to clipboard operation
caxlsx copied to clipboard

Better documentation performance

Open kwerle opened this issue 1 year ago • 4 comments

The repo says:

Detailed documentation is available at:

https://www.rubydoc.info/gems/caxlsx/

The performance of that server is, frankly, abysmal. Clicking links takes 10's of seconds. Searching feels like it takes forever.

Is there another doc site? What would it take to install the doc locally?

kwerle avatar Dec 23 '24 18:12 kwerle

You can generate the docs by running yard in the repo and then serve it locally. On the other hand, we should be able to get a better recommendation on viewing the docs, maybe host it on github pages?

kiskoza avatar Jan 05 '25 15:01 kiskoza

I eventually figured that out. Either hosting somewhere performant or giving detailed docs on how to self host seem appropriate. It's just that the current link is basically useless.

kwerle avatar Jan 05 '25 17:01 kwerle

For some reason the linked documentation is performing quite well at the moment. I don't know if y'all prodded or what happened, but this really is no longer [currently] an issue.

kwerle avatar Jan 24 '25 16:01 kwerle

This issue has been automatically marked as stale because it has not been commented on for at least three months. If you have any new information or updates please reply in order to keep the issue open.

github-actions[bot] avatar Apr 25 '25 01:04 github-actions[bot]

For some reason the linked documentation is performing quite well at the moment.

It can fluctuate a little bit in my experience.

Adding a simple copy/paste "use this to run local documentation" may be useful.

rubyFeedback avatar Jul 27 '25 01:07 rubyFeedback

hey @rubyFeedback, thanks for your input on this topic. I've created a PR, could you take a look if that makes the solution more discoverable?

kiskoza avatar Aug 05 '25 13:08 kiskoza