search

coq / platform-docs

A project of short tutorials and how-to guides for Coq features and Coq Platform packages.
https://coq.inria.fr/platform-docs/
Other
19 stars 10 forks source link

Convention Section #13

Closed thomas-lamiaux closed 5 months ago

thomas-lamiaux commented 5 months ago

In the tutorial for Equations, I have used the following coqdoc syntax :

* 1. ...
** 1.1 ... 
*** 1.1.1 ...

I have noticed #11 uses

** 1. ...
*** 1.1 ...

should we fix a convention so that all files look the same once they'll be a web interface ?

Villetaneuse commented 5 months ago

The coqdoc output of (** * A single star title *) is really big. As far as I know, it's only used for the title of the document.

thomas-lamiaux commented 5 months ago

@Villetaneuse does it look big too with JsCoq ?

Villetaneuse commented 5 months ago

It really depends on your css, but I'm quite sure it really semantically means "title of the document", a bit like one # header in md is for the title.

thomas-lamiaux commented 5 months ago

Ok, I'll add it in the guidelines