Skip to content
This repository was archived by the owner on Jan 5, 2025. It is now read-only.

Commit 3ad872a

Browse files
chore: prepare for release (#212)
1 parent 06b4aa0 commit 3ad872a

File tree

3 files changed

+24
-15
lines changed

3 files changed

+24
-15
lines changed

.vale/styles/config/ignore/terms.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,4 +148,5 @@ unexpander
148148
unexpanders
149149
uninstantiated
150150
unparenthesized
151+
upvote
151152
walkthrough

Manual.lean

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,31 @@ tag := "lean-language-reference"
2727

2828

2929
This is the _Lean Language Reference_, an in-progress reference work on Lean.
30-
It is intended to be a comprehensive, precise description of Lean: a reference work in which Lean users can look up detailed information, rather than a tutorial for new users.
30+
It is intended to be a comprehensive, precise description of Lean: a reference work in which Lean users can look up detailed information, rather than a tutorial intended for new users.
3131
For other documentation, please refer to the [Lean documentation site](https://lean-lang.org/documentation/).
3232

33+
This reference manual is not yet complete, but there's enough information to provide value to users.
34+
The top priority is to add the missing information as quickly as possible while staying up to date with Lean development.
35+
As the rest of the text is written, regular snapshots will be released, tracking upstream changes.
36+
This snapshot covers Lean version {versionString}[].
37+
38+
Our prioritization of content is based on our best understanding of our users' needs.
39+
Please use the [issue tracker](https://github.com/leanprover/reference-manual/issues) to help us better understand what you need to know.
40+
In particular, please create or upvote issues for topics that are important to you.
41+
Your feedback is much appreciated!
42+
Once sufficient content is available, we will begin saving snapshots for each release of Lean and making them conveniently available.
43+
44+
API reference documentation is included from the Lean standard library source code.
45+
Due to technical limitations at the moment, the Lean terms and examples embedded in it do not render as nicely as we would like.
46+
In the near future, we will be working on removing these limitations.
47+
Additionally, we will be adding missing API reference documentation and revising and improving the existing API reference documentation.
48+
49+
**Release History**
50+
51+
: 2024-12-16
52+
53+
This is the initial release of the reference manual.
54+
3355
{include Manual.Intro}
3456

3557
{include Manual.Elaboration}

static/theme.css

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -63,17 +63,3 @@ figcaption {
6363
font-family: var(--verso-code-font-family) !important;
6464
}
6565

66-
/** Temporary measures until the real release **/
67-
@media not print {
68-
main::before {
69-
content: 'Preview Release';
70-
position: fixed;
71-
top: 0;
72-
right: 0;
73-
padding: 0.5rem 1rem;
74-
background-color: var(--lean-compl-yellow);
75-
font-family: var(--verso-structure-font-family);
76-
font-size: large;
77-
z-index: 9; /* Just below the ToC */
78-
}
79-
}

0 commit comments

Comments
 (0)