-
Notifications
You must be signed in to change notification settings - Fork 25
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add helpful command to export demos to json format for web api #11
Conversation
Good idea and thank you for the work. I've checked the website, very cool. The feature worths developing a new separate project/repo. As I prefer to keep this repo/project simple, I suggest creating a new repo for the feature if you like.
Wow, I know Algolia is good for searching docs but didn't know there is a free tier. There are 1619 demos now, which is not a lot, I guess the client side js should be able to handle the search, though it probably requires more work than the Algolia API. |
I'm fine with a new repo, I will open a new RP after you create
it.
I think we can just relay on Algolia for now, free tier is enough
since this service is quite new, If it gets popular later, we can
think ways to cut costs at that time.
…On Sat, Jul 24, 2021 at 10:48:01 PM +0800, Xu Chunyang wrote:
Good idea and thank you for the work. I've checked the website,
very cool.
The feature worths developing a new separate project/repo. As I
prefer to keep this repo/project simple, I suggest creating a
new repo for the feature if you like.
> Search requests of Algolia's [free
> tier](https://www.algolia.com/pricing/) is 10K/month,
Wow, I know Algolia is good for searching docs but didn't know
there is a free tier.
There are 1619 demos now, which is not a lot, I guess the client
side js should be able to handle the search, though it probably
requires more work than the Algolia API.
|
Another reason for a fresh repo is that, in order to make the website userful, docstring is necessary, thus elisp-demos is only one data source of the website. I have no experience in building complex websites (https://clojuredocs.org/ looks complex enough to me), what do you think about examples and comments from user contributions? will people contribute? do you know how to implement the feature? |
Yeah, docstring is necessary for a online demo service, which is
also another reason I suggest relying on Algolia.
But I haven't figured out how to associate demo with those
docstring, Xah Lee's website[1] is a reference.
clojuredocs is kinds of complex for me too, since I'm not good at
frontend development.
I think it take many time to reach what clojuredocs looks like,
but we can do it step by step.
For now, I think it's important to put the demo service online
first, then users can edit the org demo file to contribute.
(PS: the generate.el need to improve to deal with two or more
examples under one title)
If the service get more attention, then other voluteers maybe come
out.
[1]: http://ergoemacs.org/emacs/elisp_basics.html
…On Mon, Jul 26, 2021 at 10:44:47 AM +0800, Xu Chunyang wrote:
Another reason for a fresh repo is that, in order to make the
website userful, docstring is necessary, thus elisp-demos is
only one data source of the website.
I have no experience in building complex websites
(https://clojuredocs.org/ looks complex enough to me), what do
you think about examples and comments from user contributions?
will people contribute? do you know how to implement the
feature?
|
Fixes #10
I setup a demo at
Next Step:
Search requests of Algolia's free tier is 10K/month, which I think is enough for us to explore this idea.