Commit Graph

14 Commits

Author SHA1 Message Date
Jakub Klinkovský fa0cd4ff9d
docs: remove line block markup (#2729)
I don't see a point in using [line blocks][1] anywhere in the
documentation. Note that mandoc consequently renders it with a `<pre>`
tag which looks ugly on [man.archlinux.org][2].

Also simplified the URL in `index.rst` which can be written verbatim
without any special markup.

See this [archmanweb issue][3] for details.

[1]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks
[2]: https://man.archlinux.org/man/archinstall.1
[3]: https://gitlab.archlinux.org/archlinux/archmanweb/-/issues/49#note_213730

Co-authored-by: Jakub Klinkovský <1289205+lahwaacz@users.noreply.github.com>
2024-10-14 09:59:08 +11:00
Rafael Fontenelle 0d5e1cf752
Fix misspellings (#2306) 2024-03-07 13:19:44 +01:00
Anton Hvornum 4955b64a8c
Added --skip-ntp to docs (#2273) 2023-11-29 13:04:56 +01:00
Anton Hvornum e28ba95370
Restoring back the docs with a commit, as I'm clearly incapable of grasping git's reset/revert features.. (#2249) 2023-11-22 22:45:25 +01:00
Anton Hvornum d7eb35f4ee
Nuking docs to allow for redirect (ouff) (#2245) 2023-11-22 22:24:29 +01:00
Anton Hvornum cc806d9c4c
Started a re-write of the docs (#1967)
* Started a re-write of the docs, using CSV for tables and re-organizing parameter definitions

* Added final config options in --config, some have external references which needs to be populated

* Forgot to escape a comma

* Clarified a note

* Added disk configuration and disk encryption docs

* Changed way of installing using source and python

* Added a 'list script' that lists available scripts. This could be converted to a argparse later. But this does the trick for now. And it's added to ease documentation and listing of available options.

* Added a 'Known issues' section, as well as renamed the issues tab

* Finished up the known issues section

* Added a section regarding --plugin

* Added plugin description, tweaked disk_config to the latest changes from #2221

* Added custom-commands docs, and improved some creds and known issue links
2023-11-21 14:34:30 +01:00
Anton Hvornum bb37dae16b Added instructions on how to post logs publicly. 2022-01-14 10:23:16 +01:00
Anton Hvornum 7c20c8fb56 Improved mentions of logs and configuration files. This fixes #839 2022-01-14 10:03:56 +01:00
Anton Hvornum ddb0810af0
Improve documentation v2.3.1 (#843)
* Updated documentation

Mostly I've moved things around, cleaned up some dead paths and added more clarity.

* Cleaned up !superusers section

* Mentioning of accessibility
2022-01-05 23:42:06 +01:00
remLse c6b499cf47
Update documentation (#803)
* Add guide for building docs locally

* Update documentation

- Fix typos
- Fix some formatting
- Fix broken links
- Improve readability of json profile specification
2021-12-18 19:01:40 +01:00
Brainfrazzle d9aec3fe21
Update discord.rst
Just edits for readability and grammar.
2021-11-02 20:28:02 -10:00
Rafael Fontenelle 5a321d6ce5 Update repo to archlinux/archinstall 2021-04-04 11:52:51 -03:00
Anton Hvornum 467878813e This corrects some syntax things for manpages #78. Mainly links are printed out fully rather than wrapping them in a hyper link label. 2021-01-26 14:45:11 +01:00
Anton Hvornum ee9af976ca Updated documentation
Related to the new log features.
2020-11-08 10:56:29 +01:00