Giter Site home page Giter Site logo

Migrate the Chalmers Wiki about agda HOT 4 OPEN

lawcho avatar lawcho commented on June 16, 2024
Migrate the Chalmers Wiki

from agda.

Comments (4)

jespercockx avatar jespercockx commented on June 16, 2024 3

I think ideally we should also have a user-facing front page that is not the user manual or the github page. It doesn't have to contain a lot of information, but just a short explanation of what Agda is plus links to the various other places. This is the main role that the wiki currently serves imho (albeit poorly).

from agda.

andreasabel avatar andreasabel commented on June 16, 2024 1

I update the "Download" page on the wiki, and the standard libraries' page is also updated.
We also use it to organise the Agda meetings.
Esp. the latter is not something that should go into the user manual. Thus, before we have an alternative where to host such content, we can't give up the Chalmers wiki.

That said, it would be nice to have a nice looking front page, just no one has taken this chore up ever.

from agda.

lawcho avatar lawcho commented on June 16, 2024

RE a user-facing "front page"

Yes, I agree that:

  • Agda should get one
  • It should not be "doc style"

However:

  • We could share infrastructure between the docs, "front page", paper list, etc.

Case study

LiquidHaskell uses mkdocs for all its user-facing documentation, including:

LH front page

Halfway through a LH blog post

This was implemented in 2021 (ucsd-progsys/liquidhaskell#1862),
previously LH had separate blog and docs (ucsd-progsys/liquidhaskell#1852).

Other features to copy from the LH docs:

  • .github.io domain
    • Shorter than .readthedocs.io
    • Not doc-specific
  • Programming animations on the "front page"
  • Modern look & feel (due to mkdocs)
    • Nav-bar
    • Real-time search bar
    • Keyboard shortcuts
    • Split ToC
      • Left: "sections in this page"
      • Right: "pages in this website"
    • "Back to top" button (that doesn't get in the way)
    • Misc. design: colors, layout, etc.

from agda.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.