PR comment fixes

This commit is contained in:
Ruben Perez
2023-05-17 13:11:45 +02:00
committed by Alan de Freitas
parent 1269b38c84
commit aa3cfedae5
24 changed files with 46 additions and 49 deletions

View File

@@ -5,14 +5,14 @@
** xref:becoming-author/portability-requirements.adoc[]
** xref:becoming-author/organization-requirements.adoc[]
** xref:becoming-author/docs-requirements.adoc[]
** xref:becoming-author/library-design-guidelines.adoc[]
** xref:becoming-author/managing-dependencies.adoc[]
** xref:becoming-author/design-guide.adoc[]
** xref:becoming-author/dependencies.adoc[]
** xref:becoming-author/separate-compilation.adoc[]
** xref:becoming-author/header.adoc[]
** xref:becoming-author/borland.adoc[]
** xref:becoming-author/library-metadata.adoc[]
** xref:becoming-author/release-notes.adoc[]
* xref:source-control.adoc[]
* xref:version-control.adoc[]
* xref:cmake.adoc[]
* xref:testing/intro.adoc[]
** xref:testing/boost-test-matrix.adoc[]

View File

@@ -1,5 +1,4 @@
= Library Design Guidelines
:navtitle: Library Design Guidelines
= Design Guide
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.

View File

@@ -1,4 +1,4 @@
= Documentation requiremens
= Documentation Requiremens
@anarthal: this is taken verbatim from old content. It may be outdated.

View File

@@ -1,4 +1,4 @@
= Boost Header policy
= Boost Header Policy
:idprefix:
:idseparator: -

View File

@@ -1,4 +1,4 @@
= Becoming a library author
= Author a Library
This section describes the requirements and guidelines for the content of a library submitted to Boost.
@@ -21,7 +21,7 @@ To avoid a proposed library being rejected, it must meet these requirements:
. The library should preferably meet the xref:./organization-requirements.adoc[Organization Requirements]. But is only required to meet them after acceptance.
. The library must come reasonably close to meeting the
xref:./library-design-guidelines.adoc[Library Design Guidelines].
xref:./design-guide.adoc[Library Design Guidelines].
. The author must be willing to participate in discussions
on the mailing list, and to refine the library accordingly.

View File

@@ -1 +1 @@
= Release notes
= Release Notes

View File

@@ -1,4 +1,4 @@
= Separate compilation
= Separate Compilation
:idprefix:
:idseparator: -

View File

@@ -1,4 +1,4 @@
= Getting involved
= Getting Involved
@anarthal: content suggestion: How can you contribute to Boost?

View File

@@ -1,4 +1,4 @@
= Using CIs
= Continious Integration
@anarthal: content suggestion:

View File

@@ -1,4 +1,4 @@
= Testing in Boost
= Testing
:idprefix:
:idseparator: -

View File

@@ -1,4 +1,4 @@
= Writing tests
= Writing Tests
@anarthal: content suggestion:
@@ -7,5 +7,5 @@
* Running tests from b2 and cmake
* Running examples as tests
* Running docs snippets as tests
* What if I have integration tests?
* Testing libraries that depend on external systems
* Testing cmake workflows

View File

@@ -1,4 +1,4 @@
= Source control
= Version Control (Git)
@anarthal: content suggestion:

View File

@@ -1 +1 @@
= Managing a review
= Managing a Review

View File

@@ -1 +1 @@
= Writing a review
= Writing a Review

View File

@@ -1,12 +1,15 @@
* xref:intro.adoc[Introduction to Boost]
* xref:intro.adoc[]
* xref:getting-started.adoc[]
* xref:whats-in-boost.adoc[]
* xref:bsl.adoc[]
* xref:reporting-bugs.adoc[]
* xref:advanced-building-boost.adoc[]
* xref:release-process.adoc[]
* xref:whats-inside.adoc[]
* xref:reporting-issues.adoc[]
* xref:advanced-builds.adoc[]
* xref:faq.adoc[]
* xref:boost-history.adoc[]
* xref:tutorials.adoc[]
* Community
** xref:bsl.adoc[]
** xref:release-process.adoc[]
** xref:boost-history.adoc[]
* Reference
** xref:library-naming.adoc[]

View File

@@ -1,4 +1,4 @@
= Building Boost: advanced uses cases
= Advanced Builds
@anarthal: content suggestions:
@@ -6,4 +6,4 @@
* How can I build Boost with the old/new ABI (gcc)?
* How can I use pass:[libc++] instead of pass:[libstdc++]?
* How can I use `link=static` vs `link=dynamic`?
* Consider moving the "building Boost with CMake" discussion here
* Consider moving the "building Boost with CMake" discussion here. https://github.com/boostorg/cmake provides some good info

View File

@@ -1,5 +1,4 @@
= History of Boost
:navtitle: History of Boost
= History
This topic aims to provide an overview of the origins, growth, and impact of Boost on the programming community.

View File

@@ -1,9 +1,7 @@
= Introduction
:idprefix:
:idseparator: -
:leveloffset: +1
= Introduction to Boost
:navtitle: Introduction to Boost
Boost is a collection of peer-reviewed and high-quality libraries that aim to make application development more productive for all C++ developers.

View File

@@ -1,4 +1,4 @@
= The Boost Release Process
= Release Process
@anarthal: shorten this and phrase it from a user perspective. Keep the long version for the contributor guide and place a link here

View File

@@ -1,4 +1,4 @@
= Reporting bugs
= Reporting issues
:idprefix:
:idseparator: -

View File

@@ -0,0 +1 @@
= Tutorials

View File

@@ -1,13 +0,0 @@
= What's in Boost?
@anarthal: TBC: content. Talk about the different useful stuff we have, for example:
* Containers, algorithms, iterators
* Generic & template meta
* Math & numerics
* Concurrent
* Image processing
* Networking
* Testing
Suggestions: talk about combining libs for certain use cases (task-based/scenario-based approach), e.g. gaming, server application, embedded, etc.

View File

@@ -0,0 +1,10 @@
= What's inside?
@anarthal: TBC: content. Talk about the different useful stuff we have.
Suggestions:
* Talk about STL equivalents that are superior in performance
* Talk about networking
* Talk about combining libs for certain use cases (task-based/scenario-based approach), e.g. gaming, server application, embedded, etc.
* Talk abour projects that are already using Boost (bitcoint-core, mysql server, MongoDB server, React Native)