Update info.rkt to add category

[spdegabrielle]

Update info.rkt scribblings parameter to add "DrRacket Plugin" category.

[Metaxal]

Hey Stephen, I'm not entirely clear what this change is supposed to be doing. Can you clarify?

[spdegabrielle]

Adds quickscript to the DrRacket Plugins category on docs.racket-lang.org
via the third parameter in scribblings https://docs.racket-lang.org/raco/setup-info.html#%28idx._%28gentag._16._%28lib._scribblings%2Fraco%2Fraco..scrbl%29%29%29

[Metaxal]

This commit doesn't seem to work:

raco-local: WARNING: bad 'scribblings info: '(("scribblings/quickscript.scrbl" () (tool "DrRacket Plugin") "quickscript")) 

I'm not sure what was wrong with the previous state though? Quickscript was already in the Tools section.

[spdegabrielle]

The goal is to make the top level of docs.racket-lang.org

i made a couple of dozen PR’s in different packages - unfortunately yours is one of two where I made a mistake.

i’ve fixed the PR but but you may disagree with my categorisation.

[spdegabrielle]

since I posted this one of my PR’s has been accepted:

racket/racket#4687
Superseding the change

[Metaxal]

@sorawee mentions the category should be "DrRacket Plugins" (plural) instead. WDYT?

[spdegabrielle]

The symbol in singular maps to the heading in plural
(drracket-plugin "DrRacket Plugins")

this is the convention
in pkgs/racket-index/scribblings/main/config.rkt

[sorawee]

Actually, one thing that I forgot to think about is backward compatibility for Quickscript w.r.t. the drracket-plugin symbol. 'drracket-plugin will work fine for Racket 8.10, but it's unclear what will happen in prior versions. Can you test?

[spdegabrielle]

I've given https://pkgd.racket-lang.org/pkgn/package/Coroutines a non-existent category symbol.
We will see how it goes.

(define scribblings
  (list (list "coroutines.scrbl"
              (list 'multi-page)
              (list 'concurrency)
              "coroutines")))

[Metaxal]

On Racket 8.9.0.5, this is how it appears:

I guess there's an automatic camel case based on the symbol? 🤔

[sorawee]

@Metaxal it looks like you are testing against the first commit of this PR, but the PR has since been updated to use a symbol instead. Can you try again?

[Metaxal]

This is weird. My quickscript/info.rkt says:

(define scribblings '(("scribblings/quickscript.scrbl" () (drracket-plugin) "quickscript")))

so I tried to change it to

(define scribblings '(("scribblings/quickscript.scrbl" () (drracket-pluginnnn) "quickscript")))

but this had no effect. Tried reloading the page and ignoring the cache, same thing. There may be something wrong with my Racket install.

Edit: raco pkg show -l | grep quickscript also shows the correct directory...
Edit 2: raco setup quickscript && raco setup --doc-index && raco docs same story
Edit 3: This is getting weirder. I managed to finally trigger an update of the doc main page by removing another package, but not by setup quickscript even followed by raco setup --doc-index. Changing the QS docs does work though, it's just the top page that isn't updated.

[Metaxal]

Apparently if the category is wrong, it just puts the docs back into "Misc", but since I can't manage to trigger the update of the top page it's complicated to test.

[rfindler]

It should work to throw away the generated directory that contains the html page. (And there may be a bug to fix in scribble somewhere.) Robby

…

On Thu, Jul 13, 2023 at 5:47 AM Laurent Orseau ***@***.***> wrote: Apparently if the category is wrong, it just puts the docs back into "Misc", but since I can't manage to trigger the update of the top page it's complicated to test. — Reply to this email directly, view it on GitHub <#69 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AADBNMH3KXRRXY3JKFJI2JTXP4LOXANCNFSM6AAAAAAZ27LZJQ> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[Metaxal]

Ah, finally! Deleting index.html and raco setup --doc-index works, thanks @rfindler.