docs: various fixes and cleanups
Change-Id: Ib20f89395bf7864e04080c0e69aec93ab8099a47
diff --git a/docs/index.rst b/docs/index.rst
index 226ca26..8dda472 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,29 +1,34 @@
PSYNC - Partial/Full Sync Library based on BF and IBF
=====================================================
-PSync is an ndn-cxx based C++ library for name synchronization that uses
+PSync is a C++ library for name synchronization that implements the `PSync protocol
+<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 library implements the `PSync protocol <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 `ndn-cxx <https://github.com/named-data/ndn-cxx>`_ library as NDN development
-library.
+PSync uses the `ndn-cxx <https://github.com/named-data/ndn-cxx>`__ library.
-PSync is an open source project licensed under LGPL 3.0 (see ``COPYING.md`` for more
-detail). We highly welcome all contributions to the PSync code base, provided that
-they can be licensed under LGPL 3.0+ or other compatible license.
+Contributing
+------------
-Please submit any bugs or issues to the `PSync issue tracker
-<https://redmine.named-data.net/projects/PSync/issues>`__.
+We greatly appreciate contributions to the PSync code base, provided that they are
+licensed under the LGPL 3.0+ or a compatible license (see `COPYING.md
+<https://github.com/named-data/PSync/blob/master/COPYING.md>`__ for more information).
+If you are new to the NDN software community, please read the `Contributor's Guide
+<https://github.com/named-data/.github/blob/master/CONTRIBUTING.md>`__ to get started.
+
+Please submit any bug reports or feature requests to the `PSync issue tracker
+<https://redmine.named-data.net/projects/psync/issues>`__.
PSync Documentation
-------------------
.. toctree::
:hidden:
- :maxdepth: 3
+ :maxdepth: 2
install
examples
@@ -33,4 +38,4 @@
- :doc:`install`
- :doc:`examples`
- :doc:`RELEASE-NOTES`
-- :doc:`releases`
\ No newline at end of file
+- :doc:`releases`