Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs for site plugin: adjust for recent changes to tlSiteIsTypelevelProject #562

Merged
merged 2 commits into from
Jun 24, 2023
Merged

docs for site plugin: adjust for recent changes to tlSiteIsTypelevelProject #562

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4cf87f
docs for site plugin: adjust for recent changes to tlIsTypelevelProject
jenshalm Jun 24, 2023
57b76b8
mention affiliate projects
jenshalm Jun 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/site.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,21 +61,21 @@ On top of the defaults of Laika standalone, sbt-typelevel-site adds:

#### Additional Defaults for Typelevel Projects

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
```
Comment on lines -64 to -69
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a section for Affiliate projects based on my somewhat limited understanding of the intentions. Feel free to rephrase or expand if necessary.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Organization value is package-private and the Affiliate is not,

Yes, the idea is to discourage users from claiming they are an organization project. We'll see how it works 😀


With the flag above (which defaults to `false`) these additional settings apply:
If the generated documentation is for a Typelevel project (meaning its `organization` setting is `org.typelevel`),
a set of additional defaults will be enabled on top of the generic defaults listed in the previous section:

* The home link in the top navigation bar carries the Typelevel logo and points to the Typelevel site.
* Links to the Typelevel Discord and Typelevel Twitter are inserted into the top navigation bar.
* The Typelevel favicons are used for the generared site.
* The Typelevel favicons are used for the generated site.
* A default footer for Typelevel projects is added to the bottom of each page.
* Theme support for the browser's dark mode is disabled.

Typelevel projects can opt out of these additional defaults with the following setting:

```scala
tlSiteIsTypelevelProject := None
```


### Customization

Expand Down