Skip to content

Commit e4bc767

Browse files
authored
Reorganizing navigation for "Contributors guide" component (#109)
* Reorganizing navigation for component * Removing obsolete files
1 parent c988164 commit e4bc767

File tree

4 files changed

+8
-7
lines changed

4 files changed

+8
-7
lines changed

docs/contributors/modules/ROOT/nav.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
* xref:docs-style:index.adoc[Docs style guide]
2-
** xref:docs-style:style-guide-overview.adoc[Style guide overview]
1+
* Docs style guide
32
** xref:docs-style:formatting.adoc[Formatting]
43
** xref:docs-style:style-and-voice.adoc[Style and voice]
54
** xref:docs-style:headings.adoc[Headings]
65
** xref:docs-style:using-lists.adoc[Using lists]
7-
** xref:docs-style:links.adoc[Cross references and lists]
6+
** xref:docs-style:links.adoc[Cross references and links]
87
** xref:docs-style:using-images.adoc[Using images]
9-
** xref:docs-style:using-tables.adoc[Tables]
8+
** xref:docs-style:using-tables.adoc[Using tables]
109
** xref:docs-style:using-code-samples.adoc[Using code samples]
11-
* xref:templates:index.adoc[Content templates]
10+
* Content templates
1211
** xref:templates:template-conceptual.adoc[Template for a conceptual page]
1312
** xref:templates:template-how-to.adoc[Template for a how-to page]
1413
** xref:templates:template-tutorial.adoc[Template for a tutorial page]

docs/contributors/modules/ROOT/pages/index.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,7 @@
22
:page-description: An overview of contributing to CircleCI docs including page templates and our style guide.
33
:icons: font
44
:experimental:
5+
6+
This guide is a reference for contributors to CircleCI docs. Our style guide evolves so you will probably find older documentation does not meet the requirements set out here. Use this guide to help you write new docs, and when working on existing documentation it would be great if you can make edits to help keep everything consistent.
7+
8+
For further information on markdown and asciidoc syntax refer to the https://github.github.com/gfm/[markdown documentation] and https://asciidoctor.org/docs/user-manual/[Asciidoctor User Guide].

docs/contributors/modules/docs-style/pages/index.adoc

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/contributors/modules/templates/pages/index.adoc

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)