:information_source: Hello everyone. Those who wer...
# general
w
ℹ️ Hello everyone. Those who were on the call a few hours ago know I'll be modernizing the Pants website tooling a bit, to see if we can speed up development and CI. At the same time, I thought it might be worth seeing if there were any quick wins, or slow annoyances, that users (particularly our newer users) are having with the docs ℹ️ To that end, I'll be going through the Slacks to try to categorize some problems that I think can be solved with better docs. I'd appreciate any constructive feedback anyone has on the https://www.pantsbuild.org/ website. The more actionable, the more likely we'll be able to fix it in short order. So, in that spirit: • Are there any "quick wins" that we should implement? • Are there any ideas/concepts we can take borrow steal annex share with other projects with good documentation sites? • (New users especially) Particularly irritating pain points? Any FAQs that would have been game changing? • etc Relatedly, here are some of the companies using 👖 (https://www.pantsbuild.org/spotlight/users) - we love to see this list grow, so if your company is using Pants, I'd love to add you to this ever-growing list!
🧵 1
Example: I think the Svelte/Kit docs are absolutely the cats pajamas, but it's a language/library/framework - so it's not a 1:1 correlation. But, I view it as being one of the best docs, API references, live tutorials, etc sites around
p
reference docs for
__defaults__
and other dunder BUILD file symbols are only available via cli. They are (inadvertently?) excluded from the website.
😧 1
This is not a quick win, but I think https://diataxis.fr/ is a good way to think about how to structure documentation. It would be really good to see if we can use it to make the pants docs more approachable.
❤️ 1
w
I love that diataxis site - that's like, the kinda stuff I nerd out on
❤️ 1
g
The "Add your organization or company" link on https://www.pantsbuild.org/spotlight/users goes to https://www.pantsbuild.org/register which is a 404.