mirror of
https://github.com/boostorg/website-v2-docs.git
synced 2026-01-19 04:42:17 +00:00
Contributor guide navtitles added
This commit is contained in:
Peter Turcan
committed by
Alan de Freitas
Alan de Freitas
parent
352dee5002
commit
466f2d0d05
@@ -1,23 +1,23 @@
|
||||
|
||||
|
||||
* xref:intro.adoc[Introduction to becoming a Boost Contributor]
|
||||
** xref:license-requirements.adoc[License Requirements]
|
||||
** xref:portability-requirements.adoc[Portability Requirements]
|
||||
** xref:organization-requirements.adoc[Organization Requirements]
|
||||
** xref:library-design-guidelines.adoc[Library Design Guidelines]
|
||||
* xref:intro.adoc[]
|
||||
** xref:license-requirements.adoc[]
|
||||
** xref:portability-requirements.adoc[]
|
||||
** xref:organization-requirements.adoc[]
|
||||
** xref:library-design-guidelines.adoc[]
|
||||
* xref:antora.adoc[Antora Guide]
|
||||
* Legacy Content
|
||||
** xref:documentation-overview.adoc[Writing Documentation for Boost - Documentation Structure]
|
||||
** xref:documentation-structure-guidelines.adoc[Boost Library Documentation Guidelines]
|
||||
** xref:documentation-overview.adoc[]
|
||||
** xref:documentation-structure-guidelines.adoc[]
|
||||
** Templates
|
||||
*** xref:templates/01-overview-template.adoc[Overview Template]
|
||||
*** xref:templates/02-header-template.adoc[Header Template]
|
||||
*** xref:templates/03-configuration-template.adoc[Configuration Template]
|
||||
*** xref:templates/04-rationale-template.adoc[Rationale Template]
|
||||
*** xref:templates/05-definitions-template.adoc[Definitions Template]
|
||||
*** xref:templates/06-faq-template.adoc[FAQ Template]
|
||||
*** xref:templates/07-bibliography-template.adoc[Bibliography Template]
|
||||
*** xref:templates/08-acknowledgements-template.adoc[Acknowledgments Template]
|
||||
*** xref:templates/01-overview-template.adoc[]
|
||||
*** xref:templates/02-header-template.adoc[]
|
||||
*** xref:templates/03-configuration-template.adoc[]
|
||||
*** xref:templates/04-rationale-template.adoc[]
|
||||
*** xref:templates/05-definitions-template.adoc[]
|
||||
*** xref:templates/06-faq-template.adoc[]
|
||||
*** xref:templates/07-bibliography-template.adoc[]
|
||||
*** xref:templates/08-acknowledgements-template.adoc[]
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Writing Documentation for Boost - Documentation Structure
|
||||
:navtitle: Standards Documentation Structure
|
||||
|
||||
== Introduction
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Boost Library Documentation Guidelines
|
||||
:navtitle: General Documentation Guidelines
|
||||
|
||||
It is not a requirement for a Boost library for the documentation to adhere to the following structure. However, it is listed here as a guide, if needed.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Introduction to becoming a Boost Contributor
|
||||
:navtitle: Becoming a Boost Contributor
|
||||
|
||||
This section describes the requirements and guidelines for the content of a library submitted to Boost.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Library Design Guidelines
|
||||
:navtitle: Library Design Guidelines
|
||||
|
||||
Please use these guidelines as a checklist for preparing the content a library submission. Not every guideline applies to every library, but a reasonable effort to comply is expected.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= License Requirements
|
||||
:navtitle: License Requirements
|
||||
|
||||
The preferred way to meet the license requirements is to use the https://www.boost.org/LICENSE_1_0.txt[Boost Software License]. See license information. If for any reason you do not intend to use the Boost Software License, please discuss the issues on the Boost developers mailing list first.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Organization Requirements
|
||||
:navtitle: Organization Requirements
|
||||
|
||||
The quality of the Boost libraries is not just about the APIs and code design. But also about presenting a consistent view to users of the libraries as a whole. Upon acceptance libraries must adhere to this directory and file structure:
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Portability Requirements
|
||||
:navtitle: Portability Requirements
|
||||
|
||||
* A library's interface must be portable and not restricted to a particular compiler or operating system.
|
||||
* A library's implementation must if possible be portable and not restricted to a particular compiler or operating system. If a portable implementation is not possible, non-portable constructions are acceptable if reasonably easy to port to other environments, and implementations are provided for at least two popular operating systems (such as UNIX and Windows).
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Overview Template
|
||||
:navtitle: Overview
|
||||
|
||||
Provide a brief overview of the focus and features of your library.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Header Template
|
||||
:navtitle: Header
|
||||
|
||||
Provide a complete API reference to your library.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Configuration Template
|
||||
:navtitle: Configuration
|
||||
|
||||
Describe the configuration macros that are used in your library.
|
||||
|
||||
@@ -19,9 +20,9 @@ http://www.boost.org/libs/config/config.htm[<boost/config.hpp>], as well as conf
|
||||
These are the macros that may be defined by an application using
|
||||
`<LibraryName>`.
|
||||
|
||||
[cols="1,2"]
|
||||
[cols="1,2",options="header",stripes=even]
|
||||
|===
|
||||
|*Macro* |*Meaning*
|
||||
| Macro | Meaning
|
||||
|`macro` |meaning text
|
||||
|`macro` |meaning text
|
||||
|===
|
||||
@@ -30,9 +31,9 @@ These are the macros that may be defined by an application using
|
||||
|
||||
These macros are defined by `<LibraryName>`, but are expected to be used by application code.
|
||||
|
||||
[cols="1,2"]
|
||||
[cols="1,2",options="header",stripes=even]
|
||||
|===
|
||||
|*Macro* |*Meaning*
|
||||
| Macro | Meaning
|
||||
|`macro` |meaning text
|
||||
|`macro` |meaning text
|
||||
|===
|
||||
@@ -41,9 +42,9 @@ These macros are defined by `<LibraryName>`, but are expected to be used by appl
|
||||
|
||||
These macros are defined by `<LibraryName>` and are implementation details of interest only to implementers.
|
||||
|
||||
[cols="1,2"]
|
||||
[cols="1,2",options="header",stripes=even]
|
||||
|===
|
||||
|*Macro* |*Meaning*
|
||||
| Macro | Meaning
|
||||
|`macro` |meaning text
|
||||
|`macro` |meaning text
|
||||
|===
|
||||
@@ -57,9 +58,9 @@ These macros are defined by `<LibraryName>` and are implementation details of in
|
||||
These are the macros that may be defined by an application using
|
||||
`<LibraryName>`.
|
||||
|
||||
[cols="1,2"]
|
||||
[cols="1,2",options="header",stripes=even]
|
||||
|===
|
||||
|*Macro* |*Meaning*
|
||||
| Macro | Meaning
|
||||
|`add(x,y)` | The x and y values are added together.
|
||||
|`mult(x,y)` | The x and Y values are multiplied together.
|
||||
|===
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Rationale Template
|
||||
:navtitle: Rationale
|
||||
|
||||
A Rationale provides a description of the motivation behind the library. Describe the current problems that exist, and the goals of the library in addressing those problems.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Definitions Template
|
||||
:navtitle: Definitions
|
||||
|
||||
If you library uses any terminology that might benefit from a description, consider adding Definitions to your documentation.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Frequently Asked Questions (FAQs) Template
|
||||
:navtitle: FAQ
|
||||
|
||||
If a Frequently Asked Questions (FAQ) would add value to your documentation, by aiding developers with answers to known issues or complexities, then copy the source below into your AsciiDocs source documentation.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Bibliography Template
|
||||
:navtitle: Bibliography
|
||||
|
||||
If bibliographic references are required in your documentation for your library, add a bibliography to the documentation.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
= Acknowledgements Template
|
||||
:navtitle: Acknowledgements
|
||||
|
||||
If acknowledgements are required for your library, add an acknowledgements section to the documentation. As a rule of thumb, the acknowledgements should be ordered with the most important contributions coming first. Links can be included, if required.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user