fix: miscellaneous fixes on documentations (#528)

* fix: miscellaneous fixes on documentation, notary-server.

* Revert notary changes.

* Add warning when TLS is off.

CHANGELOG.md

@@ -1,7 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]

CONTRIBUTING.md

@@ -16,25 +16,6 @@ keywords.
 
 Try to do one pull request per change.
 
-### Updating the changelog
-
-Update the changes you have made in
-[CHANGELOG](CHANGELOG.md)
-file under the **Unreleased** section.
-
-Add the changes of your pull request to one of the following subsections,
-depending on the types of changes defined by
-[Keep a changelog](https://keepachangelog.com/en/1.0.0/):
-
-- `Added` for new features.
-- `Changed` for changes in existing functionality.
-- `Deprecated` for soon-to-be removed features.
-- `Removed` for now removed features.
-- `Fixed` for any bug fixes.
-- `Security` in case of vulnerabilities.
-
-If the required subsection does not exist yet under **Unreleased**, create it!
-
 ## Style
 
 ### Capitalization and punctuation

README.md

@@ -8,7 +8,7 @@
 
 [mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
 [apache-badge]: https://img.shields.io/github/license/saltstack/salt
-[actions-badge]: https://github.com/tlsnotary/tlsn/actions/workflows/ci.yml/badge.svg
+[actions-badge]: https://github.com/tlsnotary/tlsn/actions/workflows/ci.yml/badge.svg?branch=dev
 [actions-url]: https://github.com/tlsnotary/tlsn/actions?query=workflow%3Aci+branch%3Adev
 
 [Website](https://tlsnotary.org) |

notary/server/README.md

@@ -103,7 +103,7 @@ The main objective of a notary server is to perform notarizations together with
 ### Features
 #### Notarization Configuration
 To perform a notarization, some parameters need to be configured by the prover and the notary server (more details in the [OpenAPI specification](./openapi.yaml)), i.e.
-- maximum transcript size
+- maximum data that can be sent and received
 - unique session id
 
 To streamline this process, a single HTTP endpoint (`/session`) is used by both TCP and WebSocket clients.

notary/server/openapi.yaml

@@ -183,7 +183,6 @@ components:
           type: integer
       required:
         - "clientType"
-        - "maxTranscriptSize"
     NotarizationSessionResponse:
       type: object
       properties:

tlsn/examples/discord/README.md

@@ -27,7 +27,7 @@ You can find the `CHANNEL_ID` directly in the url:
 `https://discord.com/channels/@me/{CHANNEL_ID)`
 
 ## Start the notary server
-1. Edit the notary server [config file](../../../notary/server/config/config.yaml) to turn off TLS so that self-signed certificates can be avoided.
+1. Edit the notary server [config file](../../../notary/server/config/config.yaml) to turn off TLS so that self-signed certificates can be avoided (⚠️ this is only for local development purposes — TLS must be used in production).
    ```yaml
     tls:
         enabled: false

tlsn/examples/simple/README.md

@@ -85,6 +85,6 @@ Feel free to try these extra challenges:
 
 ### Next steps
 
-Try out the [Discord example](../Discord/README.md) and notarize a Discord conversations.
+Try out the [Discord example](../discord/README.md) and notarize a Discord conversations.
 
 

tlsn/examples/twitter/README.md

@@ -26,7 +26,7 @@ Next, open the **Developer Tools**, go to the **Network** tab, and refresh the p
 ![Screenshot](twitter_dm_browser.png)
 
 ## Start the notary server
-1. Edit the notary server [config file](../../../notary/server/config/config.yaml) to turn off TLS so that self-signed certificates can be avoided.
+1. Edit the notary server [config file](../../../notary/server/config/config.yaml) to turn off TLS so that self-signed certificates can be avoided (⚠️ this is only for local development purposes — TLS must be used in production).
    ```yaml
     tls:
         enabled: false