You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Twilight publishes a book to https://twilight.rs containing a beginner friendly overview of Twilight and, from 0.15 onwards, Twilight's changelog, but this is not well advertised to users looking at just the GitHub repository (Twilight's Discord server, however, links to it in the #info channel). There's primarily three ways of advertising links in a GitHub repository:
Repository website / link (currently set to an invite link to the Discord server).
Inside the top-level readme (as a banner at the top or in plaintext)
As an environment (the API documentation is linked to this way, labeled "github-pages")
I personally consider the Discord server more important than the book, eliminating option 1. Including it in the readme as a banner is certainly possible, but it's long and crowded with less important information and would therefore likely be passed over. Mentioning the availability of the book and broadly describing its contents in the readme under its own heading is probably the best option, but it's not great for users searching for just the link as they need to scroll down past the root files, banners and logo before proceeding. Creating an environment (named, let's say "book") that links to https://twilight.rs would fix this as the environments are listed under the right pannel.
Additionally, an older version of the book is available at https://twilight-rs.github.io. This should either redirect to https://twilight.rs, like how https://twilight-rs.github.io/twilight redirects to https://api.twilight.rs, or be removed outright. Somewhat related to this, GitHub Pages currently only support one Page/repository which is why the book is published with Cloudflare Pages. We might want to switch the API documentation to Cloudflare Pages too as maintaining one configuration is easier than two. #2194 would then be superceeded.
The text was updated successfully, but these errors were encountered:
Twilight publishes a book to https://twilight.rs containing a beginner friendly overview of Twilight and, from 0.15 onwards, Twilight's changelog, but this is not well advertised to users looking at just the GitHub repository (Twilight's Discord server, however, links to it in the
#info
channel). There's primarily three ways of advertising links in a GitHub repository:I personally consider the Discord server more important than the book, eliminating option 1. Including it in the readme as a banner is certainly possible, but it's long and crowded with less important information and would therefore likely be passed over. Mentioning the availability of the book and broadly describing its contents in the readme under its own heading is probably the best option, but it's not great for users searching for just the link as they need to scroll down past the root files, banners and logo before proceeding. Creating an environment (named, let's say "book") that links to https://twilight.rs would fix this as the environments are listed under the right pannel.
Additionally, an older version of the book is available at https://twilight-rs.github.io. This should either redirect to https://twilight.rs, like how https://twilight-rs.github.io/twilight redirects to https://api.twilight.rs, or be removed outright. Somewhat related to this, GitHub Pages currently only support one Page/repository which is why the book is published with Cloudflare Pages. We might want to switch the API documentation to Cloudflare Pages too as maintaining one configuration is easier than two. #2194 would then be superceeded.
The text was updated successfully, but these errors were encountered: