aboutsummaryrefslogtreecommitdiff
blob: 2eae34fb8a73e59eb520ca263a19ade672d7f1b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
---
nav1: support
nav2: documentation
nav2-show: true

title: 'Documentation'
---
<div class="alert alert-info">
  <strong>Looking for the Gentoo Handbook?</strong>
  <br>
  <a href="https://wiki.gentoo.org/wiki/Handbook:Main_Page" class="btn btn-info pull-right">
    <span class="fa fa-fw fa-book"></span> Gentoo Handbook
  </a>
  <p>
    Our most referred to piece of documentation is the Gentoo Handbook.
    It describes the installation process of a new Gentoo system in detail.
    Click the button on the right to directly start reading it.
  </p>
</div>

<p>
  Most of our documentation is available on the <a href="//wiki.gentoo.org">Gentoo Wiki</a>:
</p>

<div class="row">
  <div class="col-xs-12 col-md-8 col-md-offset-2">
    <div class="panel panel-default">
      <div class="panel-heading">
        <h3 class="panel-title">Finding Documentation on the <a href="//wiki.gentoo.org">Gentoo Wiki</a></h3>
      </div>
      <div class="panel-body">
        If you know what you are looking for, you can simply search for one or more keywords:
        <br><br>
        <form method="get" action="//wiki.gentoo.org/index.php?title=Special:Search">
          <div class="input-group input-group-lg">
            <input type="text" class="form-control" placeholder="Search on wiki.gentoo.org" name="search">
            <span class="input-group-btn">
              <button class="btn btn-default" type="submit"><span class="fa fa-fw fa-search"></span></button>
            </span>
          </div>
        </form>

        <br>
        Or, browse the Wiki contents using these categories:
        <br><br>

        <div class="list-group" style="font-size: 125%;">
          <a href="//wiki.gentoo.org/wiki/Category:Core_system" title="Category:Core system" class="list-group-item"><i class="fa fa-fw fa-terminal"></i> Core System</a>
          <a href="//wiki.gentoo.org/wiki/Category:Software" title="Category:Software" class="list-group-item"><i class="fa fa-fw fa-floppy-o"></i> Software</a>
          <a href="//wiki.gentoo.org/wiki/Category:Hardware" title="Category:Hardware" class="list-group-item"><i class="fa fa-fw fa-print"></i> Hardware</a>
          <a href="//wiki.gentoo.org/wiki/Category:Desktop" title="Category:Desktop" class="list-group-item"><i class="fa fa-fw fa-desktop"></i> Desktop</a>
          <a href="//wiki.gentoo.org/wiki/Category:Server_and_Security" title="Category:Server and Security" class="list-group-item"><i class="fa fa-fw fa-database"></i> Server and Security</a>
          <a href="//wiki.gentoo.org/wiki/Category:Project_and_Community" title="Category:Project and Community" class="list-group-item"><i class="fa fa-fw fa-institution"></i> Project and Community</a>
        </div>

        <strong>Did you know?</strong>
        Our documentation team maintains a list of <a href="//wiki.gentoo.org/wiki/Project:Documentation/Overview">featured Wiki articles</a> that are worth a read.
      </div>
    </div>
  </div>
</div>

<h2>Developer Documentation</h2>

<p>
  In addition to the documentation available on the Wiki, we also offer documentation resources geared towards Gentoo development:
</p>

<ul>
  <li><a href="https://devmanual.gentoo.org/">Gentoo Development Guide</a></li>
  <li><a href="https://devmanual.gentoo.org/eclass-reference/index.html">eclass Reference</a></li>
</ul>