Skip to content

Conversation

@CodingCellist
Copy link
Member

Description

The final page under the "Crash Course in Idris2" was severely out of date, for example it mentioned the freenode IRC channel, which we moved off of years ago.

This PR updates:

  • The IRC link to point to libera.chat.
  • The question links to group the mailing list and the discord, as well as note that the discord is currently the most active place (similar to the note on the idris-lang website).
  • The list to include the Idris2 tutorial originally written by Stefan Höck, which is probably the best current & up-to-date tutorial on Idris2.
  • The links to papers to only include the Idris papers themselves (since that seems manageable to maintain), pointing to the idris-lang website for the list of papers generally involving Idris (introduced in Create Papers page idris-lang.github.io#16 )

(Related: andrevidela/idris-documentation-tracking#7 )

* Point people at the mailing list rather than just mentioning it
  exists.
* Fix the discord invite link.
* Fix the IRC link (we moved off freenode alongside everyone else, and
  that was years ago).
The website is not really related to questions, so it makes more sense
to group the mailing list with the discord.  As part of that separation,
then, add a brief sentence on what the website does.

Similar to the website, mention that the discord is currently the most
active interactive discussion place.
This is likely the closest one can come to a "Type-Driven Development
with Idris **2**" book, so it should be near the top.

Huge props to Stefan Höck for writing the original, and to the community
for turning it into an mdBook and now having stewardship of it.
Having the original Idris papers on the readthedocs is probably
manageable.  However, to save us having to keep multiple "Papers" pages
in sync, I'm pointing back to the website for papers involving Idris in
general.
@CodingCellist CodingCellist added documentation Improvements or additions to documentation enhancement labels Oct 16, 2025
As listed, they were showing as Idris1 ^3 ^2 , which was just slightly
bothering me.
The links for "pack collection" and "third-party libraries" were missing
a space between the display text and the ref, leading to incorrect
hyperlinks in the readthedocs output.
@CodingCellist CodingCellist changed the title [docs] Bring conclusions.rst up to speed [docs] Bring conclusions.rst up to speed, fix links in packages.rst Oct 17, 2025
@CodingCellist
Copy link
Member Author

Sorry, should have looked into how to do this before submitting the PR: I built the readthedocs locally, and had a nit-pick with the order of the footnotes for Idris1 (they now appear in numeric order), but also got a warning that the links to pack's collection and the "third-party libraries" pages were incorrectly formatted, which I figured I might as well fix while I was doing work on the docs.

@CodingCellist CodingCellist merged commit 5419fdb into idris-lang:main Oct 24, 2025
3 checks passed
@CodingCellist CodingCellist deleted the readthedocs-fixup branch October 24, 2025 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants