Re: Question about documentation
Raymond Toy <[email protected]> Fri, 1 Aug 2025 07:52:40 -0700
| Newsgroups | gmane.lisp.common-lisp-net.devel |
|---|---|
| Message-ID | <[email protected]> |
This is a multi-part message in MIME format.
--------------aC3tvCzn01MmtZzgEOI7pHZI
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
On 8/1/25 3:34 AM, Marco Antoniotti wrote:
> Hi
>
> Let me reiterate that I am very lazy. Therefore I ask here (and not
> and AI) for help.
>
> I know I did it in the past, but please walk me through it again or
> point me to the right site.
>
> I have a library. In the old days I had a 'docs' directory in the
> main one and then I would generate (*) the documentation there. Now I
> need to shift the documentation to the .dev web pages.
>
> How exactly do I do that? Making sure I also have the YAML stuff working?
So you want to have documentation on c-l.net?
I think the first step is to get some kind of "organization" set up.
Then you can populate it with the repos you want, including an
"organization".common-lisp.dev. This repo would contain all the
documentation you want to be shown on "organization".common-lisp.dev. I
suppose it could contain other stuff too. I never tried.
I don't know if there's any other way, but I have CI setup to generate
the docs and copy them over to the appropriate place which then pushes
them to organization.common-lisp.dev for display. The page gets updated
whenever I push changes to the repo.
​
--------------aC3tvCzn01MmtZzgEOI7pHZI
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
<!DOCTYPE html>
<html>
<head>
<meta http-equiv=3D"content-type" content=3D"text/html; charset=3DUTF=
-8">
<title></title>
<meta charset=3D"utf-8">
</head>
<body>
<div class=3D"markdown-here-wrapper">
<p style=3D"margin-bottom: 19.2px; margin-top: 0px;">On 8/1/25 3:34=
AM, Marco Antoniotti wrote:</p>
<blockquote type=3D"cite"
style=3D"border-block-color: rgb(119, 119, 119); border-bottom-color: rgb=
(119, 119, 119); border-inline-color: rgb(114, 159, 207) rgb(119, 119, 11=
9); border-inline-start: 2px solid rgb(114, 159, 207); border-left: 2px s=
olid rgb(114, 159, 207); border-right-color: rgb(119, 119, 119); border-t=
op-color: rgb(119, 119, 119); color: rgb(119, 119, 119); column-rule-colo=
r: rgb(119, 119, 119); margin: 19.2px 0px; outline-color: rgb(119, 119, 1=
19); padding-inline: 16px; padding-left: 16px; padding-right: 16px; quote=
s: none; text-decoration-color: rgb(119, 119, 119); text-emphasis-color: =
rgb(119, 119, 119);">
<div class=3D"external-content" id=3D"extcontent-0"
style=3D"border-block-color: rgb(119, 119, 119); border-bottom-color: rgb=
(119, 119, 119); border-inline-color: rgb(119, 119, 119); border-left-col=
or: rgb(119, 119, 119); border-right-color: rgb(119, 119, 119); border-to=
p-color: rgb(119, 119, 119); color: rgb(119, 119, 119); column-rule-color=
: rgb(119, 119, 119); outline-color: rgb(119, 119, 119); quotes: none; te=
xt-decoration-color: rgb(119, 119, 119); text-emphasis-color: rgb(119, 11=
9, 119);">
<div dir=3D"ltr">
<div>Hi</div>
<div><br>
</div>
<div>Let me reiterate that I am very lazy.=C2=A0 Therefore I =
ask
here (and not and AI) for help.</div>
<div><br>
</div>
<div>I know I did it in the past, but please walk me through
it again or point me to the right site.</div>
<div><br>
</div>
<div>I have a library.=C2=A0 In the old days I had a 'docs'
directory in the main one and then I would generate (*)
the documentation there.=C2=A0 Now I need to shift the
documentation to the .dev web pages.</div>
<div><br>
</div>
<div>How exactly=C2=A0do I do that?=C2=A0 Making sure I also =
have the
YAML stuff working?<br>
</div>
</div>
</div>
</blockquote>
<p style=3D"margin-bottom: 19.2px; margin-top: 0px;">So you want to=
have documentation on c-l.net?</p>
<p style=3D"margin-bottom: 19.2px; margin-top: 0px;">I think the
first step is to get some kind of "organization" set up. Then
you can populate it with the repos you want, including an
"organization".common-lisp.dev. This repo would contain all the
documentation you want to be shown on
"organization".common-lisp.dev. I suppose it could contain other
stuff too. I never tried.</p>
<p style=3D"margin-bottom: 19.2px; margin-top: 0px;">I don't know i=
f
there's any other way, but I have CI setup to generate the docs
and copy them over to the appropriate place which then pushes
them to organization.common-lisp.dev for display. The page gets
updated whenever I push changes to the repo.</p>
</div>
<div class=3D"mdhr-raw"
style=3D"height:0;width:0;max-height:0;max-width:0;overflow:hidden;font-s=
ize:0;padding:0;margin:0;"
aria-hidden=3D"true"
title=3D"MDH:PHA+PGJyPjwvcD48ZGl2IGNsYXNzPSJtb3otY2l0ZS1wcmVmaXgiPk9uIDgv=
MS8yNSAzOjM0IEFNLCBNYXJjbyBBbnRvbmlvdHRpIHdyb3RlOjxicj48L2Rpdj48YmxvY2txd=
W90ZSB0eXBlPSJjaXRlIiBjaXRlPSJtaWQ6Q0FHME53MmtFcVM4clV5ZVVXNGRwc2lobTRKcm=
Q9T1lfbVZKQ2VGdjdIZXc3eVVGMkd3QG1haWwuZ21haWwuY29tIj4KPG1ldGEgaHR0cC1lcXV=
pdj0iY29udGVudC10eXBlIiBjb250ZW50PSJ0ZXh0L2h0bWw7ICI+PGRpdiBkaXI9Imx0ciI+=
PGRpdj5IaTwvZGl2PjxkaXY+PGJyPjwvZGl2PjxkaXY+TGV0IG1lIHJlaXRlcmF0ZSB0aGF0I=
EkgYW0gdmVyeSBsYXp5LiZuYnNwOyBUaGVyZWZvcmUgSSBhc2sgaGVyZSAoYW5kIG5vdCBhbm=
QgQUkpIGZvciBoZWxwLjwvZGl2PjxkaXY+PGJyPjwvZGl2PjxkaXY+SSBrbm93IEkgZGlkIGl=
0IGluIHRoZSBwYXN0LCBidXQgcGxlYXNlIHdhbGsgbWUgdGhyb3VnaCBpdCBhZ2FpbiBvciBw=
b2ludCBtZSB0byB0aGUgcmlnaHQgc2l0ZS48L2Rpdj48ZGl2Pjxicj48L2Rpdj48ZGl2Pkkga=
GF2ZSBhIGxpYnJhcnkuJm5ic3A7IEluIHRoZSBvbGQgZGF5cyBJIGhhZCBhICdkb2NzJyBkaX=
JlY3RvcnkgaW4gdGhlIG1haW4gb25lIGFuZCB0aGVuIEkgd291bGQgZ2VuZXJhdGUgKCopIHR=
oZSBkb2N1bWVudGF0aW9uIHRoZXJlLiZuYnNwOyBOb3cgSSBuZWVkIHRvIHNoaWZ0IHRoZSBk=
b2N1bWVudGF0aW9uIHRvIHRoZSAuZGV2IHdlYiBwYWdlcy48L2Rpdj48ZGl2Pjxicj48L2Rpd=
j48ZGl2PkhvdyBleGFjdGx5Jm5ic3A7ZG8gSSBkbyB0aGF0PyZuYnNwOyBNYWtpbmcgc3VyZS=
BJIGFsc28gaGF2ZSB0aGUgWUFNTCBzdHVmZiB3b3JraW5nPzxicj48L2Rpdj48L2Rpdj48L2J=
sb2NrcXVvdGU+PHA+U28geW91IHdhbnQgdG8gaGF2ZSBkb2N1bWVudGF0aW9uIG9uIGMtbC5u=
ZXQ/PC9wPjxwPkkgdGhpbmsgdGhlIGZpcnN0IHN0ZXAgaXMgdG8gZ2V0IHNvbWUga2luZCBvZ=
iAib3JnYW5pemF0aW9uIiBzZXQgdXAuJm5ic3A7IFRoZW4geW91IGNhbiBwb3B1bGF0ZSBpdC=
B3aXRoIHRoZSByZXBvcyB5b3Ugd2FudCwgaW5jbHVkaW5nIGFuICJvcmdhbml6YXRpb24iLmN=
vbW1vbi1saXNwLmRldi4mbmJzcDsgVGhpcyByZXBvIHdvdWxkIGNvbnRhaW4gYWxsIHRoZSBk=
b2N1bWVudGF0aW9uIHlvdSB3YW50IHRvIGJlIHNob3duIG9uICJvcmdhbml6YXRpb24iLmNvb=
W1vbi1saXNwLmRldi4mbmJzcDsgSSBzdXBwb3NlIGl0IGNvdWxkIGNvbnRhaW4gb3RoZXIgc3=
R1ZmYgdG9vLiZuYnNwOyBJIG5ldmVyIHRyaWVkLjxicj48L3A+PHA+SSBkb24ndCBrbm93IGl=
mIHRoZXJlJ3MgYW55IG90aGVyIHdheSwgYnV0IEkgaGF2ZSBDSSBzZXR1cCB0byBnZW5lcmF0=
ZSB0aGUgZG9jcyBhbmQgY29weSB0aGVtIG92ZXIgdG8gdGhlIGFwcHJvcHJpYXRlIHBsYWNlI=
HdoaWNoIHRoZW4gcHVzaGVzIHRoZW0gdG8gb3JnYW5pemF0aW9uLmNvbW1vbi1saXNwLmRldi=
Bmb3IgZGlzcGxheS4mbmJzcDsgVGhlIHBhZ2UgZ2V0cyB1cGRhdGVkIHdoZW5ldmVyIEkgcHV=
zaCBjaGFuZ2VzIHRvIHRoZSByZXBvLjxicj48L3A+PGJyPjx1bCBjbGFzcz0iZHJvcGRvd24t=
bWVudSB0ZXh0Y29tcGxldGUtZHJvcGRvd24iIHN0eWxlPSJkaXNwbGF5OiBub25lOyBwb3Npd=
GlvbjogYWJzb2x1dGU7IHotaW5kZXg6IDEwMDA7IiBjb250ZW50ZWRpdGFibGU9ImZhbHNlIi=
Bwb3BvdmVyPSJhdXRvIj48L3VsPg=3D=3D">&#8203;</div>
</body>
</html>
--------------aC3tvCzn01MmtZzgEOI7pHZI--