Ilya Grigoriev
2218143968
docs: create a basic homepage for the docs website
...
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html .
Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.
An additional motivation is the desire to have a homepage to
link to from
https://github.com/martinvonz/jj/pull/2273#discussion_r1331008117 .
Better something very basic than nothing.
2023-10-03 19:58:22 -07:00
Ilya Grigoriev
dbbed2d2a5
docs: restore directory structure of the website
...
The `offline` plugin added to the MkDocs config in commit 772e2b856aec196https://martinvonz.github.io/jj/v0.9.0/revsets >
<https://martinvonz.github.io/jj/v0.9.0/revsets/ >
and <https://martinvonz.github.io/jj/v0.9.0/revsets.html > was invalid.
The situation described above should be restored by this commit.
**After** 772e2b8https://martinvonz.github.io/jj/v0.9.0/revsets >
<https://martinvonz.github.io/jj/v0.9.0/revsets.html > and
<https://martinvonz.github.io/jj/v0.9.0/revsets/ > was invalid.
This commit is likely to break the version switcher between v0.9.0 and newer
versions. The breakage would be minimized if this is merged shortly before a
release (but with enough time to test it out). Alternatively, I could try to
fix up the docs for that version.
We could also consciously decide to leave things as they are now.
The problem was noticed by @hooper, who noticed URLs in their browser history
that were no longer valid.
2023-10-02 20:40:23 -07:00
Philip Metzger
5b729a90a9
docs/design: Move the run doc to github.
...
This ticks another box in #1869 .
Co-Authored-By: arxanas <me@waleedkhan.name>
Co-Authored-By: hooper <hooper@google.com>
Co-Authored-By: martinvonz <martinvonz@google.com>
2023-09-14 16:39:40 +02:00
Ilya Grigoriev
772e2b8be6
GitHub release action: publish HTML docs in an archive
2023-08-31 20:44:08 -07:00
Ilya Grigoriev
b67c115c29
docs: goodbye Github, hello GitHub
2023-08-28 10:43:48 -07:00
Ilya Grigoriev
fc49258d2f
docs: Set up mkdocs and poetry
...
I initially was thinking of using `mdbook`, which looks a little better, but I
think versioning the docs is important, and the features I want are pretty much
only supported by the Mkdocs' "Material" theme.
Mkdocs is written in Python. The prerequesites for building docs on your
machine should be to install Python and Poetry, everything else should be
installed automatically by Poetry. See the edits to `contributing.md` for more details.
2023-08-28 10:43:48 -07:00
