RFC

RFC Doc Generator APIs

Feature Name: TypeScript Migration and API Specifications.
Type: Enhancement

Start Date: 2023-01-17

Author: Radhay

Related components: Roadmap

Summary

• Redefining APIs to make them more generic and idempotent
• Defining types and interfaces for fewer errors, memory optimization, and easy documentation

Motivation

To make doc generator an adoptable product that can be easily scaled to serve bulk tasks at the enterprise level easily with the least amount of hassle. The goal is to have a single product for all the document create/share/archive tasks in an organization that is user-friendly and user-centric too.

Detailed design

This is the bulk of the RFC. Explain the design in enough detail for somebody familiar with the network to understand, and for somebody familiar with the code practices to implement. This should get into specifics and corner-cases, and include examples of how the feature is used.

Drawbacks

I Why should we not do this?

Alternatives

What other designs have been considered? What is the impact of not doing this?

Unresolved questions

What parts of the design are still to be done?