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

Typedoc #127

Merged
merged 8 commits into from
May 15, 2024
Merged

Typedoc #127

merged 8 commits into from
May 15, 2024

Conversation

Juuddi
Copy link
Contributor

@Juuddi Juuddi commented May 14, 2024

Major Changes:

  • Migrate all inline comments to JSDoc format
  • Migrate all existing .wrm files to .md files
  • Add typedoc + typedoc plugin deps

Minor Changes:

  • Add docs/ directory to house new docs files
  • Update .npmignore
  • Add typedoc.json docs config file
  • Update tsconfig.base.json module prop to comply with typedoc
  • Remove all static assets in docs.wrm/ directory

rileystephens28
rileystephens28 reviewed May 14, 2024
View reviewed changes
docs/cookbook/ens.md Outdated Show resolved Hide resolved
docs/contributing.md Outdated Show resolved Hide resolved
docs/contributing.md Outdated Show resolved Hide resolved
@Juuddi Juuddi requested a review from rileystephens28 May 14, 2024 21:17
@Juuddi Juuddi merged commit b2e3a68 into master May 15, 2024
@Juuddi Juuddi deleted the typedoc branch May 15, 2024 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rileystephens28 rileystephens28 rileystephens28 approved these changes

@alejoacosta74 alejoacosta74 Awaiting requested review from alejoacosta74

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Juuddi @rileystephens28