mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2024-11-24 15:18:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 12
jj/docs/index.md

27 lines
1.1 KiB
Markdown
Raw Normal View History

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-04 01:20:04 +00:00
# Jujutsu—a version control system
## Welcome to `jj`'s documentation website!
<!-- This only applies to the website, not to the GitHub interface -->
docs index.md: explain that the website sidebar may be hidden This happens on mobile browsers or when the browser window is too narrow.
2023-10-04 07:30:22 +00:00
The complete list of the available documentation pages is located in
the sidebar on the left of the page. The sidebar may be hidden; if so,
you can open it either by widening your browser window or by clicking
on the hamburger menu that appears in this situation.
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-04 01:20:04 +00:00
docs index.md: explain that the website sidebar may be hidden This happens on mobile browsers or when the browser window is too narrow.
2023-10-04 07:30:22 +00:00
Additional help is available using the `jj help` command if you have
`jj` installed.
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-04 01:20:04 +00:00
You may want to jump to:
- Documentation for the [latest released version of `jj`](https://martinvonz.github.io/jj/latest).
- Documentation for the [unreleased version of `jj`](https://martinvonz.github.io/jj/prerelease). This version of the docs corresponds to the `main` branch of the `jj` repo.
## Some useful links
- [GitHub repo for `jj`](https://github.com/martinvonz/jj)
docs index.md: Make README link a bit more reliable The original link would likely be broken by the change to the heading title in https://github.com/martinvonz/jj/pull/2273.
2023-10-04 07:05:00 +00:00
- Overview of `jj` in the repo's [README](https://github.com/martinvonz/jj?tab=readme-ov-file#readme)
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-04 01:20:04 +00:00
- [Installation and Setup](install-and-setup.md)
- [Tutorial and Birds-Eye View](tutorial.md)
- [Working with GitHub](github.md)
docs: add link to roadmap from docs main page The roadmap seems like something users might want to read soon after they find the project, so a link from the main page seems useful to me.
2024-09-04 04:44:34 +00:00
- [Development Roadmap](roadmap.md)
Reference in a new issue Copy permalink