|
1 | | -Stellar Docs |
| 1 | +Deprecated Stellar Docs |
2 | 2 | ============ |
3 | 3 |
|
4 | | -This repository is home to the Stellar documentation. These docs feed into the [Stellar developers site builder](https://github.com/stellar/developers) and are on display at [stellar.org/developers](https://www.stellar.org/developers/). |
| 4 | +We've completed migration to our newest documentation. This repo is deprecated and will no longer be supported. Any new issues need to be filed in the new document repo https://github.com/stellar/new-docs |
5 | 5 |
|
6 | | -## How to write docs |
7 | | - |
8 | | -There are a few conventions when writing docs that go into the Stellar Developers site. Most of the docs are written in Markdown format. For an introduction to Markdown, take a look at [Github's Mastering Markdown Guide](https://guides.github.com/features/mastering-markdown/). |
9 | | - |
10 | | -### Headers |
11 | | - |
12 | | -Lines that start with a hash symbol (`#`) are considered headers. Below is an example of a few and the name of the header: |
13 | | - |
14 | | -``` |
15 | | -# h1 |
16 | | -## h2 |
17 | | -### h3 |
18 | | -#### h4 |
19 | | -``` |
20 | | - |
21 | | -- DO NOT use h1 since that is reserved for the page title generated from front matter. |
22 | | -- DO NOT skip a header size (don't go from h2 to h4). |
23 | | -- DO use smaller headers (more hash symbols) to represent that a section is nested under a parent one with a larger header. |
24 | | -- DO add a space after the hash symbols. Some Markdown parsers will not render the text as a header without the space. |
25 | | - |
26 | | -### Front matter |
27 | | - |
28 | | -At the top of most documents is something called "front matter". This is metadata for the file written in [YAML format](https://en.wikipedia.org/wiki/YAML). |
29 | | - |
30 | | -Here is an example of front matter in action: |
31 | | -``` |
32 | | ---- |
33 | | -title: Horizon Reference |
34 | | ---- |
35 | | -``` |
36 | | - |
37 | | -The currently used keys in the front matter are: |
38 | | -- title |
39 | | - |
40 | | -### Document title |
41 | | - |
42 | | -Do not start a page with a Markdown header (`# Title`). Instead, leave it in the front matter. The developers site will take the title from the front matter. |
43 | | - |
44 | | -### Links |
45 | | - |
46 | | -Use inline links and not reference links. |
47 | | - |
48 | | -There are three different kinds of links, and each different kind of link has a significant meaning. Some of these links are transformed in the generation of the developers site. |
49 | | - |
50 | | -<table> |
51 | | - <tbody> |
52 | | - <tr> |
53 | | - <th>link type</th> |
54 | | - <th>where to use</th> |
55 | | - <th>markdown link example</th> |
56 | | - <th>resulting link (after dev portal processing)</th> |
57 | | - </tr> |
58 | | - <tr> |
59 | | - <tr> |
60 | | - <td>Relative</td> |
61 | | - <td><ul><li>links within same repository</li></ul></td> |
62 | | - <td>../reference/accounts-all.md</td> |
63 | | - <td>../reference/accounts-all.html</td> |
64 | | - </tr> |
65 | | - <tr> |
66 | | - <td>Root relative</td> |
67 | | - <td><ul><li>when you want to use the GitHub file viewer (e.g. for source files)</li></ul></td> |
68 | | - <td>/src/ledger/AccountFrame.cpp</td> |
69 | | - <td>https://github.com/stellar/CURRENT-REPOSITORY/tree/master/src</td> |
70 | | - </tr> |
71 | | - <tr> |
72 | | - <td>Absolute links</td> |
73 | | - <td> |
74 | | - <ul> |
75 | | - <li>cross repository links (should link to the dev portal at www.stellar.org/developers/)</li> |
76 | | - <li>links to external sites (like https://www.google.com/)</li> |
77 | | - </ul> |
78 | | - </td> |
79 | | - <td>https://www.stellar.org/developers/js-stellar-base/reference/building-transactions.html</td> |
80 | | - <td>https://www.stellar.org/developers/js-stellar-base/reference/building-transactions.html</td> |
81 | | - </tr> |
82 | | - </tbody> |
83 | | -</table> |
84 | | - |
85 | | -### Non-markdown files |
86 | | - |
87 | | -Sometimes we want to include other types of content such as `.pdf`'s. To add front matter to the PDF, create a sibling file with the PDF file name and an added extension of `.metadata`. This file can then define metadata for the title of the `.pdf`. |
88 | | - |
89 | | -An example can be seen in [stellar-core's software folder](https://github.com/stellar/stellar-core/tree/master/docs/software). |
90 | | - |
91 | | -## Contributing |
92 | | - |
93 | | -Your contributions to the Stellar network will help improve the world’s financial infrastructure, faster. |
94 | | - |
95 | | -We want to make it as easy as possible to contribute changes that help the Stellar network grow and thrive. There are a few guidelines that we ask contributors to follow so that we can merge your changes quickly. Please read our [Contribution Guide](https://github.com/stellar/docs/blob/master/CONTRIBUTING.md) and sign our [Contributor License Agreement](https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform). |
0 commit comments