PR feedback (tech writer edits)

alexcamposruiz · alexcamposruiz · commit 72a49fc22249 · 2026-01-14T12:52:54.000-08:00
diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md
@@ -4,9 +4,8 @@ RTI Connector for Rust uses an XML configuration file to define participants,
 readers, writers, topics, types, and QoS. The XML schema is the same one used
 by RTI Connext DDS XML-Based Application Creation.
 
-For background on the XML format, see:
-
-* <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/xml_application_creation/index.htm>
+For background on the XML format, see the
+[RTI XML-Based Application Creation guide](https://community.rti.com/static/documentation/connext-dds/current/doc/manuals/connext_dds_professional/xml_application_creation/index.htm).
 
 ## Loading a configuration
 
@@ -23,7 +22,7 @@ fn load_config() -> rtiddsconnector::ConnectorFallible {
 
 The `config_name` must match a `<domain_participant>` element in the XML.
 
-## XML tags and Connector API
+## XML tags and Connector API mapping
 
 The table below summarizes the most common XML tags and how they map to the
 Connector API:
@@ -73,7 +72,8 @@ Domains register types and define topics:
 
 ## Participants, readers, and writers
 
-Participants contain publishers and subscribers, which contain writers/readers:
+Participants contain publishers and subscribers, which in turn manage individual
+writers and readers:
 
 ```xml
 <domain_participant_library name="MyParticipantLibrary">
@@ -114,7 +114,7 @@ QoS can be configured at the profile level or per-entity. Example profile:
 
 ## Examples in this repo
 
-The repository includes XML examples you can adapt:
+This repository includes XML examples you can adapt:
 
 * `examples/MyApplication.xml`
 * `examples/shapes/Shapes.xml`
diff --git a/docs/guide/connector.md b/docs/guide/connector.md
@@ -1,10 +1,15 @@
 # Connector lifecycle
 
+This chapter covers creating a connector, acquiring inputs and outputs, and
+cleaning up native resources.
+
 [`crate::Connector`] represents a DDS `DomainParticipant` configured from XML.
 It owns native resources and creates `Input` and `Output` handles.
 
 ## Importing the crate
 
+To import the crate:
+
 ```rust
 use rtiddsconnector::{self, Connector};
 ```
@@ -24,7 +29,7 @@ fn create_connector() -> rtiddsconnector::ConnectorFallible {
 ```
 
 The XML file defines your types, QoS profiles, and DDS entities. The call above
-loads a `<domain_participant>` from a `<domain_participant_library>`, for example:
+loads a `<domain_participant>` from a `<domain_participant_library>`. For example:
 
 ```xml
 <domain_participant_library name="MyParticipantLibrary">
@@ -42,8 +47,8 @@ There is no explicit `close()` method in Rust. Instead, `Connector`, `Input`, an
 `Output` are released when they go out of scope. The crate uses RAII to free
 native resources.
 
-If you want to force cleanup of Connext global resources at the end of a scope
-(for example in tests), use [`crate::GlobalsDropGuard`].
+To force cleanup of Connext global resources at the end of a scope
+(for example, in tests), use [`crate::GlobalsDropGuard`].
 
 ## Getting inputs and outputs
 
@@ -56,16 +61,14 @@ until the entity becomes available, use [`crate::Connector::take_input`] or
 See [Publishing data](crate::guide::output) and [Reading data](crate::guide::input)
 for the workflow that follows.
 
-## Threading note
-
-Operations on the same `Connector` or its contained entities are not protected
-for multi-threaded access. See [Threading and ownership](crate::guide::threading)
-for guidance.
+> **Note:** Multiple operations on the same `Connector`, or its contained
+> entities, are not protected for multi-threaded access. See
+> [Threading and ownership](crate::guide::threading) for guidance.
 
-## Auto-enable considerations
+## DataReader auto-enable considerations
 
 Connext DDS controls entity enablement through XML QoS settings (for example,
 `<entity_factory>/<autoenable_created_entities>`). If readers are enabled before
 you acquire an `Input`, data may already be available when you call
-`get_input`. This behavior comes from Connext configuration rather than the
+`get_input`. This behavior stems from your Connext configuration rather than the
 Rust API itself.
diff --git a/docs/guide/data.md b/docs/guide/data.md
@@ -7,7 +7,7 @@ accessors for common primitive fields.
 
 The types you read and write can include nested structs, sequences, arrays, and
 unions. These types are defined in XML following RTI's XML-Based Application
-Creation format. See
+Creation format. For details, see
 [RTI XML-Based Application Creation](https://community.rti.com/static/documentation/connext-dds/current/doc/manuals/connext_dds_professional/xml_application_creation/xml_based_app_creation_guide/UnderstandingXMLBased/XMLTagsConfigEntities.htm).
 
 ## JSON vs member access
@@ -46,9 +46,8 @@ fn get_basic(sample: &Sample) -> rtiddsconnector::ConnectorFallible {
 ## Accessing complex members
 
 Examples of field-name syntax for nested members, arrays, sequences, and unions
-are available in the Connector JavaScript API documentation:
-
-[Accessing the data (field-name syntax examples)](https://community.rti.com/static/documentation/connector/current/api/javascript/data.html#.)
+are available in the [Accessing the data (field-name syntax examples)](https://community.rti.com/static/documentation/connector/current/api/javascript/data.html#)
+chapter of the Connector for JavaScript API documentation.
 
 ## Type-independent access with SelectedValue
 
@@ -93,5 +92,5 @@ If you want to work with Rust structs, use Serde:
   instance.
 * [`crate::Sample::deserialize`]: deserialize a sample into a struct.
 
-These methods allow you to keep strongly typed models in your application while
+These methods allow you to keep strongly-typed models in your application while
 still using the dynamic RTI Connector API.
diff --git a/docs/guide/errors.md b/docs/guide/errors.md
@@ -27,6 +27,8 @@ To inspect the last native error message, call
 
 ## Timeout example
 
+This example waits for data and treats a timeout as a non-fatal outcome.
+
 ```rust
 use rtiddsconnector::Input;
 
@@ -45,6 +47,6 @@ fn wait_with_timeout(input: &Input) -> rtiddsconnector::ConnectorFallible {
 ## Native error details
 
 If an operation fails because of a native RTI Connector error, the
-`ConnectorError` will include the last error message from the native library.
+[`crate::ConnectorError`] will include the last error message from the native library.
 This can provide additional context when debugging configuration or data access
 issues.
diff --git a/docs/guide/getting_started.md b/docs/guide/getting_started.md
@@ -1,15 +1,17 @@
 # Getting started
 
 This crate is intended to be consumed from Cargo as a Git dependency. The
-examples in `snippets/` and `examples/` are also included in the repository.
+examples in `snippets/` and `examples/` are also included in the
+[rticonnextdds-connector-rust repository](https://github.com/rticommunity/rticonnextdds-connector-rust).
 
 ## Add the dependency
 
 ```console
 cargo add --git https://github.com/rticommunity/rticonnextdds-connector-rs
 ```
 
-If you need a specific branch, add `--branch <branch-name>`.
+This command adds the Connector for Rust repository to your project. If you
+need a specific branch, add `--branch <branch-name>`.
 
 ## Running the examples
 
@@ -22,8 +24,9 @@ See `examples/shapes/README.md` for usage details.
 
 ## Minimal example
 
-This is the typical flow: create a connector, obtain an output and input, write
-one sample, then read samples back.
+This is the typical flow for using Connector: create a connector,
+obtain an output and input, write one sample, then read samples back. For
+example:
 
 ```rust
 use rtiddsconnector::{Connector, GlobalsDropGuard, Input, Output};
@@ -56,14 +59,14 @@ fn main() -> rtiddsconnector::ConnectorFallible {
 
 At build time, `build.rs` locates the RTI Connector C libraries in this order:
 
-1. `RTI_CONNECTOR_VERSION`: downloads the target-specific libraries from the
+1. `RTI_CONNECTOR_VERSION` downloads the target-specific libraries from the
    RTI Connector GitHub releases.
-2. `RTI_CONNECTOR_DIR`: uses a local directory containing the libraries.
-3. `CARGO_MANIFEST_DIR/rticonnextdds-connector`: uses a local directory next to
+2. `RTI_CONNECTOR_DIR` uses a local directory containing the libraries.
+3. `CARGO_MANIFEST_DIR/rticonnextdds-connector` uses a local directory next to
    the crate.
-4. `CONNECTOR_VERSION` file: falls back to a version file in the crate root.
+4. `CONNECTOR_VERSION` file falls back to a version file in the crate root.
 
-If neither of these methods is successful, the build will fail with an error
+If none of the methods above is successful, the build will fail with an error
 message indicating that the C libraries could not be found.
 
 Once your application has been built, `cargo` commands will automatically pick
@@ -73,4 +76,4 @@ configuration is needed to link the RTI Connext C libraries when using
 
 At runtime, ensure the native libraries are discoverable in your system's
 library path (for example `DYLD_LIBRARY_PATH` on macOS, `LD_LIBRARY_PATH` on
-Linux, or `PATH` on Windows).
+Linux, or `PATH` on Windows).
diff --git a/docs/lib.md b/docs/lib.md
@@ -37,7 +37,7 @@ the _RTI Connector_ API:
 [omg-dds-xml]: https://www.omg.org/spec/DDS-XML/ "OMG DDS XML Specification"
 [gh-connector]: https://github.com/rticommunity/rticonnextdds-connector "RTI Connector on Github"
 
-## User Guide
+# User Guide
 
 Start here for a tour of the crate:
 
