https://pantsbuild.org/ logo
#general
Title
# general
w

wide-midnight-78598

09/02/2022, 12:03 PM
Does anyone else see value in having a target overview page like this? A table of targets per backend? https://docs.bazel.build/versions/main/be/overview.html I personally love this
1
b

bitter-ability-32190

09/02/2022, 12:27 PM
I want a development glossary for sure 😃
We already have targets in the docs, just not grouped like this
w

wide-midnight-78598

09/02/2022, 12:31 PM
Yeah, specifically the "all in one" style - it's also useful for ensuring relative consistency across targets
2
b

bitter-ability-32190

09/02/2022, 12:37 PM
Maybe after I'm done with all my todos I'll finally sit down and write docs 😂
I do think we have a few consistency-related issues 😅
b

busy-vase-39202

09/02/2022, 5:59 PM
readme has a Glossary feature that afaik we aren't using. Dunno whether we want to get too attached to their implementation given that the ultimate goal is to finish migrating off readme. But presumably they've put more thought that average into how to use a glossary. So might find some good ideas in their docs.
w

wide-midnight-78598

09/02/2022, 6:15 PM
The glossary could be pretty static once setup, backend targets don't go through too much churn after creation
My preference is in-repo generally
b

busy-vase-39202

09/02/2022, 6:17 PM
Oh hmm, their glossary feature is not your glossary feature. https://docs.readme.com/docs/glossary I see value in both.
w

witty-crayon-22786

09/02/2022, 7:10 PM
fwiw, the Target and Subsystem aspects of the site are already generated by
build-support/bin/generate_docs.py
… so adjusting that to generate an additional page based on the “providing backend” information wouldn’t be too bad
👍 3
3 Views