Skip to content

Commit

Permalink
Add a welcome landing page to the user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
David Binder committed Oct 21, 2023
1 parent 9a87e45 commit 1f6dbec
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Welcome to the Cabal User Guide
===============================

.. toctree::
welcome

.. toctree::
:maxdepth: 2
:numbered:
Expand Down
21 changes: 21 additions & 0 deletions doc/welcome.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Welcome
=======

Welcome to the Cabal user guide.
Cabal is the "common architecture for building applications and tools" and consists of a fileformat for describing Haskell packages, a library for working with those files, and a commandline tool for downloading, building and running Haskell applications and libraries.

Finding Help
------------

If you are new to Haskell and Cabal, then you can find help in the `Haskell Matrix <https://matrix.to/#/#haskell:matrix.org>`__ chat or on the official `Haskell Discourse <https://discourse.haskell.org>`__ forum.

If you want to contact the maintainers and developers of cabal, then you can join the `Cabal and Hackage Matrix <https://matrix.to/#/#hackage:matrix.org>`__ chat.
If you prefer to use mailing lists, then you can follow `libraries@haskell.org <https://mail.haskell.org/mailman/listinfo/libraries>`__ for general discussion and queries about the library ecosystem, and `cabal-devel@haskell.org <https://mail.haskell.org/mailman/listinfo/cabal-devel>`__ for the development of Cabal.

Reporting Issues and Requesting Features
----------------------------------------

Cabal is developed on `GitHub <https://github.com/haskell/cabal>`__.
Please report any flaws or feature requests on the `issue
tracker <https://github.com/haskell/cabal/issues>`__.
If you want to start contributing to Cabal yourself, then you can find help in the `CONTRIBUTING.md <https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md>`__ in the repository.

0 comments on commit 1f6dbec

Please sign in to comment.