docs: improve formatting and document structure
Change-Id: I4b0b4cc3eae000aa1c988c5d308c3f78052ad96d
diff --git a/docs/release-notes/release-notes-0.1.0.rst b/docs/release-notes/release-notes-0.1.0.rst
index 1a137a4..5b1ad72 100644
--- a/docs/release-notes/release-notes-0.1.0.rst
+++ b/docs/release-notes/release-notes-0.1.0.rst
@@ -4,12 +4,12 @@
*Release date: January 25, 2019*
Version 0.1.0 is the initial release of PSync. The PSync library implements the `PSync protocol
-<https://named-data.net/wp-content/uploads/2017/05/scalable_name-based_data_synchronization.pdf>`_.
+<https://named-data.net/wp-content/uploads/2017/05/scalable_name-based_data_synchronization.pdf>`__.
It uses Invertible Bloom Lookup Table (IBLT), also known as Invertible Bloom Filter (IBF), to represent
the state of a producer in partial sync mode and the state of a node in full sync mode. An IBF is a
compact data structure where difference of two IBFs can be computed efficiently.
In partial sync, PSync uses a Bloom Filter to represent the subscription of list of the consumer.
-PSync uses the `ndn-cxx <https://github.com/named-data/ndn-cxx>`_ library as NDN development
+PSync uses the `ndn-cxx <https://github.com/named-data/ndn-cxx>`__ library as NDN development
library.
PSync is an open source project licensed under LGPL 3.0. We highly welcome all contributions to the PSync code base, provided that they can be licensed under LGPL 3.0+ or other compatible license.
@@ -30,6 +30,6 @@
- **Miscellaneous**
- + Uses ndn-cxx **SegmentFetcher** to segment hello and sync data.
+ + Uses ndn-cxx ``SegmentFetcher`` to segment hello and sync data.
+ Provide a SegmentPublisher that can be used by other NDN applications.
- + Examples are provided in `examples` folder to show how to use the library.
+ + Examples are provided in ``examples`` folder to show how to use the library.
diff --git a/docs/release-notes/release-notes-0.2.0.rst b/docs/release-notes/release-notes-0.2.0.rst
index 0eaa225..4e0d1a0 100644
--- a/docs/release-notes/release-notes-0.2.0.rst
+++ b/docs/release-notes/release-notes-0.2.0.rst
@@ -6,12 +6,12 @@
New features
^^^^^^^^^^^^
-- **breaking change** Compress Sync Data in Full Sync by default (:issue:`5061`, :issue:`4917`)
+- *(breaking change)* Compress Sync Data in Full Sync by default (:issue:`5061`, :issue:`4917`)
- Support various compression schemes for compressing IBF and Sync Data (:issue:`5061`)
-Changes
-^^^^^^^
+Improvements and bug fixes
+^^^^^^^^^^^^^^^^^^^^^^^^^^
-- Use constant interest timeout for (discovery) sync Interest in Segment Fetcher (:issue:`4945`)
+- Use constant interest timeout for (discovery) Sync Interest in ``SegmentFetcher`` (:issue:`4945`)
- Make default jitter shorter, react to NACK after jitter
- Use ``boost::bimap`` instead of two ``std::map`` variables to store hash to prefix matching
diff --git a/docs/release-notes/release-notes-0.3.0.rst b/docs/release-notes/release-notes-0.3.0.rst
index 20c9360..ea9a61d 100644
--- a/docs/release-notes/release-notes-0.3.0.rst
+++ b/docs/release-notes/release-notes-0.3.0.rst
@@ -8,18 +8,22 @@
This effectively drops official support for Ubuntu 16.04 when using distribution-provided Boost
packages -- PSync may still work on this platform, but we provide no official support for it.
-We have taken some steps to be endian safe but PSync is not completely endian safe yet (:issue:`4818`)
-
New features
^^^^^^^^^^^^
-- **breaking** Consumer: change hello data callback to include sequence number (:issue:`5122`)
+- *(breaking change)* Consumer: change hello data callback to include sequence number (:issue:`5122`)
Improvements and bug fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^
-- **breaking** IBLT: make encoding endian safe (:issue:`5076`)
+- *(breaking change)* IBLT: make encoding endian safe (:issue:`5076`)
- Reset cached wire encoding after adding names (:issue:`5083`)
-- Consumer reacts faster on sync Interest timeout (:issue:`5124`)
+- Consumer reacts faster on Sync Interest timeout (:issue:`5124`)
- Move private classes and functions to ``psync::detail`` namespace
- Improved unit tests
+
+Known issues
+^^^^^^^^^^^^
+
+- We have taken some steps to be endian safe but PSync is not completely endian safe yet
+ (:issue:`4818`)