Prepare for release (#3)

Final changes for the initial release

---------

Co-authored-by: Daymon <[email protected]>

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+	"changelog": "@changesets/changelog-git",
+	"commit": false,
+	"fixed": [],
+	"linked": [],
+	"access": "public",
+	"baseBranch": "main",
+	"updateInternalDependencies": "patch",
+	"ignore": []
+}

.eslintrc

@@ -14,7 +14,6 @@
 	  "plugin:@typescript-eslint/recommended",
 	  "plugin:roblox-ts/recommended",
 	  "plugin:prettier/recommended",
-	  "plugin:react-hooks/recommended"
 	],
 	"overrides": [{
 		"files": [ "scripts/**/*" ],

.github/workflows/deploy.yaml

@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - main
+    paths:
+      - "wiki/**"
+      - "api/**"
 
 defaults:
   run:

CONTRIBUTING.md

@@ -8,7 +8,7 @@ some things you should know.
 
 ## Getting started
 
-Make sure you've given both the [Wiki](https://rlog.daymxn.com/rlog/docs/category/guides) and the [API Reference](https://rlog.daymxn.com/rlog/docs/api) a read before moving forward, such that you understand the design behind **rLog**.
+Make sure you've given both the [Wiki](https://rlog.daymxn.com/docs/category/guides) and the [API Reference](https://rlog.daymxn.com/docs/api) a read before moving forward, such that you understand the design behind **rLog**.
 
 ### Building
 
@@ -77,3 +77,56 @@ Code in this repo is formatted according to eslint and prettier. You can use the
 ```sh
 npm run format
 ```
+
+### Changesets
+
+We use [changesets](https://github.com/changesets/changesets) for our release notes and version bumping.
+
+When submitting a change that should be apart of a release, you
+can run the `change` script.
+
+```sh
+npm run change
+```
+
+It will prompt you with options for setting the message and version type.
+
+#### Additional Commands
+
+Output [to stdout] a summary of the pending changes for a release.
+
+```sh
+npm run change:status
+```
+
+Export the pending changes to a `changes.json` file at the root directory.
+
+```sh
+npm run change:export
+```
+
+### Releasing
+
+To invoke a release, you'll need to pull the `main` branch
+and run the `release:version` command.
+
+```sh
+npm run release:version
+```
+
+This will automatically bump the releasing projects.
+
+After merging these changes back into `main`, you can move forward
+with the actual publishing.
+
+```sh
+npm run release
+```
+
+This will publish the releasing projects to npm, with the generated changelogs.
+
+The last step will be pushing the release tags back to the repo.
+
+```sh
+npm run release:tags
+```

README.md

@@ -7,13 +7,13 @@
  <br>
 </h1>
 
-> Context based Server-Side logging solution for ROBLOX projects.
+> Context-based server-side logging solution for ROBLOX projects.
 
-![GitHub release (latest by date)](https://img.shields.io/github/v/release/daymxn/vidos?style=flat-square)
-![GitHub last commit (branch)](https://img.shields.io/github/last-commit/daymxn/vidos/main?style=flat-square)
-![GitHub issues](https://img.shields.io/github/issues/daymxn/vidos?style=flat-square)
-![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/daymxn/vidos?style=flat-square)
-![GitHub](https://img.shields.io/github/license/daymxn/vidos?style=flat-square)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/daymxn/rlog?style=flat-square)
+![GitHub last commit (branch)](https://img.shields.io/github/last-commit/daymxn/rlog/main?style=flat-square)
+![GitHub issues](https://img.shields.io/github/issues/daymxn/rlog?style=flat-square)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/daymxn/rlog?style=flat-square)
+![GitHub](https://img.shields.io/github/license/daymxn/rlog?style=flat-square)
 
 ---
 
@@ -66,42 +66,35 @@ pnpm add @rbxts/rlog
 yarn add @rbxts/rlog
 ```
 
-### Wally
-
-```toml
-[dependencies]
-Reflex = "daymxn/[email protected]"
-```
-
 ## Overview
 
-rLog is a context based server-side logging framework for ROBLOX, designed to help organize and structure your logging process.
+rLog is a Context-based server-side logging framework for ROBLOX, designed to help organize and structure your logging process.
 
-Utilizing [Correlation IDs](https://microsoft.github.io/code-with-engineering-playbook/observability/correlation-id/) via rLog's `LogContext`, you can create logging infrastructure that mirrors more entrprise-like systems; faciliating easier debugging and external auditing.
+Utilizing [Correlation IDs](https://microsoft.github.io/code-with-engineering-playbook/observability/correlation-id/) via rLog's `LogContext`, you can create logging infrastructure that mirrors more enterprise-like systems; facilitating easier debugging and external auditing.
 
 ## Documentation
 
-[Quick Start](https://rlog.daymxn.com/rlog/docs/quick-start)
+[Quick Start](https://rlog.daymxn.com/docs/quick-start)
 
-[API Reference](https://rlog.daymxn.com/rlog/docs/api)
+[API Reference](https://rlog.daymxn.com/docs/api)
 
-[Fast Breakdown](https://rlog.daymxn.com/rlog/docs/fast-breakdown)
+[Fast Breakdown](https://rlog.daymxn.com/docs/fast-breakdown)
 
-[Basic Guides](https://rlog.daymxn.com/rlog/docs/category/guides)
+[Basic Guides](https://rlog.daymxn.com/docs/category/guides)
 
-[Advanced Guides](https://rlog.daymxn.com/rlog/docs/category/advanced-guides)
+[Advanced Guides](https://rlog.daymxn.com/docs/category/advanced-guides)
 
 ## Features
 
 ### Basic Logging
 
-- Log data to the console according under different severity levels.
+- Log data to the console according to different severity levels.
 - Utilize tags (or prefixes) for individual logging instances.
 
 ### Serialization
 
-- Attach data to your log entries that gets serialized before being sent; ensuring the data is properly visable.
-- Support for deeply nested roblox data-types that don't typically translate well (eg; CFrames).
+- Attach data to your log entries that gets serialized before being sent; ensuring the data is properly visible.
+- Support for deeply nested roblox data types that don't typically translate well (e.g., CFrames).
 - Support for encoding custom classes and functions.
 - Customizable class serialization.
 
@@ -112,13 +105,13 @@ Utilizing [Correlation IDs](https://microsoft.github.io/code-with-engineering-pl
 - Automatically generate unique IDs when needed.
 - Optionally configure a custom method for providing your own ID generation.
 - Share configuration settings between context consumers, optionally unique to each invocation.
-- Optionally "suspend" logs until they're needed (ie; a `WARNING` or `ERROR` occurs.); facilitating verbose logs for easier debugging without taking up resources until they're needed.
+- Optionally "suspend" logs until they're needed (i.e., a `WARNING` or `ERROR` occurs.); facilitating verbose logs for easier debugging without taking up resources until they're needed.
 
 ### Source Context
 
 - Attach data to your logs to identify which *file* the log was sent from.
 - Attach data to your logs to identify what *line number* in the file the log was sent from.
-- Attach data to your logs to identify which *function* the log was sent from, or optionally the *nearest* named function on the stack (in the case of anonymous functions)
+- Attach data to your logs to identify which *function* the log was sent from, or optionally the *nearest* named function on the stack (in the case of anonymous functions).
 - In the case of anonymous functions, identify the nearest *named* function from where the log was sent.
 
 ### Sinks
@@ -130,14 +123,14 @@ Utilizing [Correlation IDs](https://microsoft.github.io/code-with-engineering-pl
 
 - Define callbacks that can conditionally decide to filter logs from reaching any output.
 - Define callbacks that can send logs to external services for storage and auditing.
-- Recursively define callbacks through a heirachy of logger instances and configurations; allowing you to provide callbacks for individual flows.
-- Define dynamic callbacks that change according to arguments (eg; the player).
+- Recursively define callbacks through a hierarchy of logger instances and configurations; allowing you to provide callbacks for individual flows.
+- Define dynamic callbacks that change according to arguments (e.g., the player).
 
 ### Enrichers
 
 - Define callbacks that can conditionally mutate or add data to logs.
-- Recursively define callbacks through a heirachy of logger instances and configurations; allowing you to provide callbacks for individual flows.
-- Define dynamic callbacks that change according to arguments (eg; the type of data being sent).
+- Recursively define callbacks through a hierarchy of logger instances and configurations; allowing you to provide callbacks for individual flows.
+- Define dynamic callbacks that change according to arguments (e.g., the type of data being sent).
 
 ### Configuration
 
@@ -149,23 +142,24 @@ Utilizing [Correlation IDs](https://microsoft.github.io/code-with-engineering-pl
 
 So you're ready to get started with **rLog**!
 
-You can either checkout our [Quick Start](https://rlog.daymxn.com/rlog/docs/quick-start) guide, read through our list of [Basic Guides](https://rlog.daymxn.com/rlog/docs/category/guides), or jump straight into our [API Reference](https://rlog.daymxn.com/rlog/docs/api).
+You can either checkout our [Quick Start](https://rlog.daymxn.com/docs/quick-start) guide, read through our list of [Basic Guides](https://rlog.daymxn.com/docs/category/guides), or jump straight into our [API Reference](https://rlog.daymxn.com/docs/api).
 
 > [!TIP]
-> If you're already familiar with logging libraries, you can give our [Fast Breakdown](https://rlog.daymxn.com/rlog/docs/fast-breakdown) a read to get a quick overview of what rLog provides, and where it differs from others.
+> If you're already familiar with logging libraries, you can give our [Fast Breakdown](https://rlog.daymxn.com/docs/fast-breakdown) a read to get a quick overview of what rLog provides, and where it differs from others.
 
 ## Roadmap
 
-- Remove deps/eslint/tsconfig settings that aren't needed
-- Update shields to point to rLog once repo is public
-- Double check that are links are working properly
-
-- Seperate provided sinks into a sub package
+- Add social preview to github repo after going public
+- Add publishing for wally
+- Add docs for lua usage
+- Separate provided sinks into a sub package
 - Support google cloud console logging
 - Migrate tests to individual files
+- Implement workflow for test coverage
+- Implement tests for provided workflows
 - Implement more refined serialization/assertions lib
 - Add workflow for checking API diff and version bumping according to semver
-- Add note in contributing about changelog, version bumping, and checking the api diff
+- Add note in contributing about checking the api diff
 
 ## Contributing
 

api-extractor.json

@@ -6,7 +6,8 @@
 	"enumMemberOrder": "preserve",
 	"compiler": {},
 	"apiReport": {
-		"enabled": false
+		"enabled": true,
+		"reportFolder": "<projectFolder>/api"
 	},
 	"docModel": {
 		"enabled": true,