Conversation
|
(also this leaves a bunch of random things in index because I'm not sure where to put them yet) |
There was a problem hiding this comment.
Nice work. I went through to check for broken links and found a few.
| Help | ||
| ---- | ||
|
|
||
| Fish has an extensive help system. Use the :ref:`help <cmd-help>` command to obtain help on a specific subject or command. For instance, writing ``help syntax`` displays the `syntax section <#syntax>`_ of this documentation. |
There was a problem hiding this comment.
The syntax link is broken for me (goes to interactive.html#syntax).
Also help syntax doesn't work (goes to index.html#syntax).
|
|
||
| When the cursor is over a parenthesis or a quote, fish also highlights its matching quote or parenthesis. | ||
|
|
||
| To customize the syntax highlighting, you can set the environment variables listed in the `Variables for changing highlighting colors <#variables-color>`__ section. |
Alright, you know what? That's wrong. I can recreate this whenever needed, I should just fix up the references before (basically the reference style is broken unless pointing to a full URL, if we had a sphinx linter I'd make it mark that) |
| - :ref:`dirs <cmd-dirs>` prints the stack | ||
| - :ref:`pushd <cmd-pushd>` adds a directory on top of the stack and makes it the current working directory | ||
| - :ref:`popd <cmd-popd>` removes the directory on top of the stack and changes the current working directory | ||
|
|
||
| .. _initialization: | ||
|
|
||
| Initialization files |
There was a problem hiding this comment.
This means that after "installation and Start" we have sections
- Initialization files
- Future feature flags
- Event handlers
- Debugging fish scripts
which are mostly for advanced users. Previously, we had some light introduction, showcasing how to use man and so on.
I know that this is supposed to be reference documentation, not a tutorial (we have one), but maybe make the main page minimal, and move the details somewhere else.
maybe
- Initialization files -> language
- Future feature flags -> language
- Event handlers -> interactive (?)
- Debugging fish scripts -> interactive/language
Then the "Other help pages" can probably be weeded out a bit, since we mention most sections already.
|
This is already a big improvement! LGTM |
This breaks apart the massive "index" document into 1. An "index" document that explains how to install and set up fish and links to the other documents 2. A "fish-language" document that describes the syntax and semantics of the language 3. A "fish-interactive" document that describes how to use fish interactively No change to the content has been made, only the parts have been moved from index and some of the formatting (links and header levels) were fixed. See fish-shell#7348.
|
Alright, merged now, any other improvement can be done later. |
This breaks apart the massive "index" document into
and links to the other documents
of the language
interactively
No change to the content has been made, only the parts have been moved
from index and some of the formatting (links and header levels) were
fixed.
See #7348.
I would like to have this merged sooner rather than later because most changes to the docs will break it.
Note that this is the first step, in particular we'd have to check all the content still works in context and there is still some random stuff left in index.
We might even want to make a table listing all the other documents.