← home | release notes

Release Notes

Below outlines changes to all the documentation sections.

v1.3.0

Docs Site
- 🐞 Swagger no longer requires manual refresh to render; handled via JavaScript update.
Fictional Example Docs:
- ✨ Brand new section containing:
  - ✨ Introduction to Understanding Quant Models for Fraud Detection (No Math Degree Needed): A landing page to help users find the information they need.
  - ✨ Trading Fraud and Detection Models: A top-level page, mapping models to different types of fraud. It also provides a high-level overview of how models are trained, how they work together, and the typical process flow; from a client submitting post-trade data to Company-X to receiving a report.
  - ✨ Understanding How Logistic Regression Calculates Probabilities: Explains the logistic regression formula from the client's perspective. Less math, more focus on what each part of the formula means in practical terms.
  - ✨ Tutorial: Using the Logistic Regression Formula with Sample Data: A tutorial using fictional but realistic data to demonstrate the formula in action.
  - ✨ How to Explain Model Outcomes Without Sharing Internal Logic: A guide on how to communicate quant model results without disclosing proprietary information.

Docs Site
- ✨ Renamed "Official Docs" to "Prototype Docs"
- ✨ Improved navigation structure
- ✨ Added Release Notes (this page)
Prototype Docs:
- Dividend Tracker API (API Version: v1.3.0):
  - ✨Brand new section containing:
    - ✨Overview
    - ✨How-To's
    - ✨Common Errors and Troubleshooting
    - ✨API Reference Guide (imported swagger docs from https://github.com/celesteg1/dividend-tracker-api)

✨Initial mkdocs side for my personal portfolio website CelesteG1.
✨MkDocs served at: https://celesteg1.github.io/mkdocs
✨Includes the following documentation sections:
- ✨Fictional Examples
- ✨Official Docs (prototypes)
- ✨Blog
- ✨Research and Development (R&D)

Token Lifecycle: Learn how tokens are minted, transferred, queried, and burned throughout their lifecycle.
How-To Guides: Step-by-step examples with code snippets for each major token operation.
API Reference Guide: Detailed overview of endpoints, request payloads, and response formats.
Glossary of Key Concepts: Definitions and explanations of common terminology used throughout the docs.