Skip to content

Commit 59a1335

Browse files
jaapiolinawolf
authored andcommitted
[DOCS] improve index to help people getting started
1 parent 8ca2fa7 commit 59a1335

File tree

2 files changed

+51
-16
lines changed

2 files changed

+51
-16
lines changed

docs/about.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.. include:: /include.rst.txt
2+
3+
============
4+
About Guides
5+
============
6+
7+
phpDocumentor's Guides library takes hand-written documentation in code repositories, creates an AST from that and feeds
8+
it to a renderer to create the desired output.
9+
10+
As part of this goal, the Guides library itself is more of a framework where you can plug in support for an input
11+
format, such as Restructured Text, and plug in an output format to output towards, such as HTML.
12+
13+
Supported Formats
14+
=================
15+
16+
Input
17+
-----
18+
19+
As this is a new component, the number of formats are limited and can expand in the future
20+
21+
- RestructuredText; Well-supported, though still work in progress
22+
- Markdown; Early stages, not working yet
23+
24+
Output
25+
------
26+
27+
As this is a new component, the number of formats are limited and can expand in the future
28+
29+
- HTML
30+
- LaTeX; Well-supported, though still work in progress
31+
32+
Usage
33+
=====
34+
35+
See :doc:`usage`.

docs/index.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. include:: /include.rst.txt
22

3+
:project:
4+
Guides
35
:version:
46
dev-main
57

@@ -16,17 +18,17 @@ Report issues
1618
Latest public documentation
1719
|composer_support_docs|
1820

19-
This project contains a framework for rendering documentation. It provides a simple commandline tool to render
20-
your documentation from `reStructuredText Markup <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html>`__ and
21-
`Markdown <https://daringfireball.net/projects/markdown/>`__. to HTML or LaTeX. And can be extended to support other
22-
formats.
21+
If you are building your own application you can install the libraries using `Composer <https://getcomposer.org/>`__::
2322

24-
Besides the commandline tool it also provides a number of libraries that can be used to build your own application
25-
to render the supported formats, to any format you want. On these pages is explained how to use the commandline tool
26-
and how to use the libraries.
23+
.. code:: bash
2724
28-
If you are looking for a complete solution to create a documentation website then you may want to look at
29-
`PHPDocumentor <https://phpdoc.org/>`__.
25+
composer require phpdocumentor/guides
26+
27+
This will install all basic libraries needed to get started to get started.
28+
All libraries come with support for `Symfony dependency injection <https://symfony.com/doc/current/components/dependency_injection.html>`__.
29+
This will help you to get started with the libraries in symfony applications.
30+
31+
Read more about writing your own application in the :doc:`developers` section.
3032

3133
.. tip::
3234

@@ -42,10 +44,8 @@ If you are looking for a complete solution to create a documentation website the
4244
.. toctree::
4345
:hidden:
4446

45-
installation
46-
cli/index
47-
components/index
48-
developers/index
49-
architecture
50-
reference/index
51-
contributions/index
47+
usage
48+
configuration
49+
extension/index
50+
rst-reference/index
51+
about

0 commit comments

Comments
 (0)