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.

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

docs: api docs for new feature in client #49

Merged
merged 1 commit into from
Jul 2, 2024
Merged

Conversation

wkillerud
Copy link
Contributor

@wkillerud
Copy link
Contributor Author

Maybe we ought to do the same for Podium as I did with Metrics JS. Move all contents from package's READMEs to the docsite and link to it:

https://github.com/metrics-js/client?tab=readme-ov-file#metricsclient

@digitalsadhu
Copy link
Member

Maybe we ought to do the same for Podium as I did with Metrics JS. Move all contents from package's READMEs to the docsite and link to it:

https://github.com/metrics-js/client?tab=readme-ov-file#metricsclient

I guess the concern might be that when docs are not co-located, it's easy to forget them. In practice, I've forgotten to do the docs even when they are co-located. So.. I'm open to either approach.

@wkillerud wkillerud merged commit 10dae7b into source Jul 2, 2024
2 checks passed
@wkillerud wkillerud deleted the include-exclude branch July 2, 2024 06:35
@wkillerud
Copy link
Contributor Author

The way we have it set up now we have two places we can forget to update 😄 But yeah, co-location is nice. No rush to do anything, just throwing it out there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants