Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Implement TypeDoc | documentation generator #72

Merged
merged 8 commits into from
Nov 17, 2023
Merged

feat: Implement TypeDoc | documentation generator #72

merged 8 commits into from
Nov 17, 2023

Conversation

arddluma
Copy link
Member

Description

  • Added TypeDoc
  • Added custom theme with Etherspot colors
  • Added pipeline to deploy docs

Types of changes

What types of changes does your code introduce?

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Other (please describe):

Further comments (optional)

@github-actions GitHub Actions
Copy link

Yooo! You forgot to bump the version in package.json!

@github-actions GitHub Actions
Copy link

Yooo! You forgot to bump the version in package.json!

ch4r10t33r
ch4r10t33r approved these changes Nov 17, 2023
View reviewed changes
Copy link
Member

@ch4r10t33r ch4r10t33r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Do we know why the E2E are failing? @Jineshdarjee

@arddluma
Copy link
Member Author

LGTM. Do we know why the E2E are failing? @Jineshdarjee

not related to the actual changes @ch4r10t33r

@ch4r10t33r
Copy link
Member

@arddluma pls merge

@arddluma arddluma merged commit cd2504f into master Nov 17, 2023
1 of 2 checks passed
@arddluma arddluma deleted the feature/reference-docs-typedoc branch November 17, 2023 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@0xSulpiride 0xSulpiride 0xSulpiride approved these changes

@ch4r10t33r ch4r10t33r ch4r10t33r approved these changes

@IAmKio IAmKio Awaiting requested review from IAmKio

@vignesha22 vignesha22 Awaiting requested review from vignesha22

@sarthakprp sarthakprp Awaiting requested review from sarthakprp

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@arddluma @ch4r10t33r @0xSulpiride