Comments (4)
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.
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.
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:
- User-facing "front page"
- Quick links to the LH online demo and LH tutorial
- Standard "doc style" reference docs
- A list of papers
- A blog
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
- Shorter than
- 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)
- Instance resolution runs too late, leads to `with`-abstraction failure HOT 16
- Test suite needs to be run with debug printing enabled HOT 1
- Internal error in Mimer with module parameter and matching
- Instance resolution failure in Agda 2.6.4 HOT 6
- Mimer drops part of the solution with module parameter
- Citation.cff HOT 1
- Prune the `Makefile` HOT 7
- Delete the GitHub Wiki HOT 3
- Prune `Setup.hs` HOT 5
- Reorganize `HACKING.md`
- Merge `.authorspellings` and `.mailmap` HOT 1
- Mimer internal error when querying `recRecursive` HOT 1
- Interactive highlighting remnants with lambda-where
- Pattern synonyms with named arguments can be defined but not used HOT 3
- Automatically create names for syntax
- Mangled trX/Con clause for indexed type with green slime
- Why do we `reduce` and `instantiateFull` constraints? HOT 2
- Use of Non-terminating Function in Data Declaration Makes Typechecker Loop HOT 4
- Misprinted domain-free parameters with cohesion attribute HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from agda.