feat: re-export types and add module headers

src/identities.rs

@@ -14,6 +14,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
+//! Pairs of identities mapping one forge to another.
 use serde::{Deserialize, Serialize};
 
 /// Pairs of identities mapping one forge to another. The first element is the id in the source

src/label.rs

@@ -14,6 +14,8 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
+//! Label associated to an issue or a comment
+
 use serde::{Deserialize, Serialize};
 
 /// Label associated to an issue or a comment

src/lib.rs

@@ -14,9 +14,20 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
+//! # Welcome to F3 Documentation!
+//!
+//! Please refer to the [main documentation](https://f3.forgefriends.org/) for a complete overview.
+//! This is an incomplete Rust port of the F3 library created by the ForgeFriends project.
 pub mod identities;
 pub mod label;
 pub mod reaction;
 pub mod repository;
 pub mod topic;
 pub mod user;
+
+pub use identities::Identities;
+pub use label::Label;
+pub use reaction::Reaction;
+pub use repository::Repository;
+pub use topic::Topic;
+pub use user::User;

src/reaction.rs

@@ -14,6 +14,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
+//! Reaction associated to an issue or a comment
 use serde::{Deserialize, Serialize};
 
 /// Reaction associated to an issue or a comment

src/repository.rs

@@ -14,6 +14,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
+//! VCS repository relative to a project.
 use serde::{Deserialize, Serialize};
 
 /// VCS repository relative to a project.

src/topic.rs

@@ -14,6 +14,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
+//! A list of categories associated with a project.
 use serde::{Deserialize, Serialize};
 
 /// A list of categories associated with a project.

src/user.rs

@@ -14,6 +14,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
+//! A forge user
 use serde::{Deserialize, Serialize};
 
 /// A forge user