Looks like "see also" functionality may have been added to the site by #27 , but there doesn't appear to be a way for users of the site to actually add see-also items.

See also discussion at janet-lang/janet#744 .

I think it would be useful be able to link to other functions that are related to the one you are currently looking at.

There are at least two good reasons for linking to other functions/etc:

1. Functions/macros that interact with each other

return (https://janetdocs.com/return) will always be used together with prompt (https://janetdocs.com/prompt). Users likely want to look at both docs in order to understand how they interact.

2. Improve discoverability of related functions

file/read (https://janetdocs.com/file%2fread) should link to slurp (https://janetdocs.com/slurp) to avoid users copying the read-from-file example instead of using slurp

As discussed in a PM. Probably super easy, I just don't have time at the moment.

I added a repl session to show some examples of buffer/slice, and it seems like the lines are rendered on a single row:

I checked the html real quick, and the code is wrapped in a pre so I'm not sure why it looks like this.

Hi @swlkr -- I'd like to add a feature to the Playground to assist in sharing examples, but want to run by you the approach first. I'd like to add a "SHARE" button to the playground which saves the current playground code in the db as an "ad-hoc example", and returns a permalink. The user can then send the permalink to someone else who can see and run the code. Only a logged-in user could create one of these ad-hoc examples, I would put them in a separate table from the "real" examples, and I would tag the item in the db with the user's id. (in case of abuse for example)

My thought was to use the existing sqlite db to store these (but a new table as I said). But if you are not happy with the janetdocs db adding potentially tens of thousands of little briefly-used examples, I could create a separate db file for this.

What are your thoughts?

Functions like update for example were getting overridden with joy's docs

Is there a way to fix or edit a broken example?

As pointed out at janet-lang/janet#983 the "add17" example for partial is broken (should be def instead of defn).

Hi @swlkr -- based on the conversation over at janet-lang/janet#570 in which you participated, I'm working on a PR to demonstrate integration of janet-playground into janetdocs.

I forked janetdocs and sort of got it running locally. But I had to guess at a bunch of things. (Like how to initialize the db, etc.)

Is there a test db? Is there an environment file I should use for testing? Can you disable the oauth for testing?

Any guidance would be appreciated.

-Mike

These ev/ functions need some doc care :-), pretty please.

concrete example:
searching for split doesn't bring up anything at all, but should at least list string/split.

Heyo,

Have you considered using a fixed-width font in the examples editor?

I just modified the CSS locally and it seems to work well

textarea {
    font-family: monospace;
}

Today I was adding some ev/ examples, and I thought it would be great to parse them server-side. We can then be sure they are without parse errors, but also, we can extract other symbols and auto/manually assign them as related.

Nothing immediate, just an idea.

Turns out this doesn't actually need markdown, plaintext + highlightjs will handle it 🤷‍♂️

I thought about contributing a PR for janetdocs#24, but then noticed that the project has no license.
It would probably good in general to specify the license, but I, for example, cannot contribute unless the project is under one of my employer's approved open-source licenses.

For the following example in interleave:

# excess elements of the longer list are discarded
(interleave [1] 
            [2 4] 
            [3 6])
# -> @[1 2 3]

The # on the first line comments out the entire code snippet in preview mode,

but the syntax highlighting behaves correctly after I submitted the example.

I suspect it has something to do with how code are stored in textarea, but I am not familiar with highlight.js so unfortunately I can't locate the problem in the code.

I'm finding that for me (on Debian Testing), the search functionality of the site is not working. Regardless of what I type into the search bar, nothing comes up. I can still manully type in the full url and get the docs and examples though. I tried this on both Firefox and Chromium.

Is there support for tabseq?

I'm not seeing a page for it.

Adding some examples to Janetdocs today, I really enjoy it! 🤩

Found an issue:

If you search for pos?, the link takes you to https://janetdocs.com/pos_q, which is correct.

However, if you browse through "Recent examples" to the example I added for pos?, the pos? link points to https://janetdocs.com/pos?, which is a 404 (because https://janetdocs.com/pos is a 404).

It turns out janetdocs hit the same bug which was in clojuredocs, ha! You are in good company :)

If I type array/remove and quickly hit enter, I am taken to array/concat.

If I type array/remove, then pause, then hit enter, I am taken to array/remove.

array/concat happened to be the top result of the most recent autocomplete ajax in the first case.

context: zk/clojuredocs#205

Janetdocs is great!

Would it be possible to add the special forms to the list of things you can add examples for?

I can add examples for def- but not for def.

When selecting text, I'm having problem seeing the selection:
No selection:

Selected:

In the textarea, when editing an example, I can't see the selection at all,
selected:

When I look at a Playground in JanetDocs, I'm finding it a bit difficult to read.

I'm not sure if it's because I'm using macOS in Dark Mode. Is this how it's intended to look?

/cc @MikeBeller

Also, highlight letters as search happens

Sample text on the top
Then the PEG def
Then the output

Courtesy of @yumaikas