Skip to content

fix: include type definitions generated from JSDoc#195

Merged
wkillerud merged 10 commits intomainfrom
docs
Aug 7, 2024
Merged

fix: include type definitions generated from JSDoc#195
wkillerud merged 10 commits intomainfrom
docs

Conversation

@wkillerud
Copy link
Copy Markdown
Contributor

  • Update devDependencies and use our shared configs
  • Document the API with JSDoc and generate type definitions
  • Update the README with examples from JSDoc

@wkillerud
Copy link
Copy Markdown
Contributor Author

Windows fails because of eik-lib/common#303

Copy link
Copy Markdown

@leftieFriele leftieFriele left a comment

Choose a reason for hiding this comment

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

This is a really great job tidying up all the configs + deps, while improving the documentation by 💯 . 🌮 for you.

Comment thread README.md Outdated
Comment thread src/index.js
* port: 3000,
* });
*
* console.log("Listening on http://localhost:3000");
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I was curious as to why repeat the readme docs here, as I would think one place would suffice and be easier to keep up to date over time 🤔

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Certainly easier to update, but I think there's value in having the docs both show up in an editor and available on the web. Honestly I'm thinking about adding a third location – the docs on https://eik.dev 😅 (For MetricsJS I ended up moving much of the README.md to be only on the docsite. Maybe we do something like that?)

Comment thread src/index.js
}

/**
* The pathname to the base on Eik (ex. /pkg/my-app/1.0.0/)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

"to the base on Eik" does that mean the same as "to the base path in the current sink"?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

No, the base path of the sink would be closer to /. I mean for example /pkg/my-app/1.0.0/.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

riiight, so it's the base path for the current package.

Comment thread README.md Outdated
@wkillerud wkillerud merged commit 42243ee into main Aug 7, 2024
@wkillerud wkillerud deleted the docs branch August 7, 2024 12:42
@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 7, 2024

🎉 This issue has been resolved in version 1.1.62 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants