docs for site plugin: adjust for recent changes to tlSiteIsTypelevelProject #562
Conversation
| If the generated documentation is for a Typelevel project, you can optionally enable a set of additional defaults | ||
| on top of the generic defaults listed in the previous section: | ||
|
|
||
| ```scala | ||
| tlSiteIsTypelevelProject := true | ||
| ``` |
There was a problem hiding this comment.
Wouldn't it be helpful to keep an updated version of this? What I mean is, it seems far more likely an affiliate project would like to know how they can opt-in to the Typelevel theming, rather than an org project wanting to know how it can opt-out.
There was a problem hiding this comment.
Yes, I just wasn't sure about the intention here. The Organization value is package-private and the Affiliate is not, yet in the implementation there is no difference between the two. I wasn't exactly sure what these design choices meant, so I did not write about it. 🙂
There was a problem hiding this comment.
I added a section for Affiliate projects based on my somewhat limited understanding of the intentions. Feel free to rephrase or expand if necessary.
There was a problem hiding this comment.
yet in the implementation there is no difference between the two.
We decided in typelevel/governance#34 (comment) to start collecting this information even though we don't know what do with it yet, if anything.
The
Organizationvalue is package-private and theAffiliateis not,
Yes, the idea is to discourage users from claiming they are an organization project. We'll see how it works 😀
The docs did not yet reflect recent changes:
Boolean.organizationsetting.