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

[FCE-571] Update readme and typedoc #115

Merged
merged 9 commits into from
Sep 25, 2024
Merged

[FCE-571] Update readme and typedoc #115

merged 9 commits into from
Sep 25, 2024

Conversation

mironiasty
Copy link
Member

@mironiasty mironiasty commented Sep 24, 2024

Description

Simplify main readme's and add links to current documentation

Update how typedoc is generated to make it a little more useful.

Also fix FCE-592 by adding new footer to readme

Motivation and Context

Let's have better readme's :)

Types of changes

  • Bug fix (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)

Copy link

linear bot commented Sep 24, 2024

@mironiasty mironiasty requested review from kamil-stasiak, czerwiukk and karkakol and removed request for kamil-stasiak and czerwiukk September 24, 2024 08:04
@@ -41,5 +53,3 @@ export type {
AuthErrorReason,
Encoding,
} from "@fishjam-cloud/ts-client";

export { FishjamClient } from "@fishjam-cloud/ts-client";
Copy link
Member Author

Choose a reason for hiding this comment

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

@kamil-stasiak @czerwiukk Is there reason to keep this class exported? We have useFishjamClient hook.

@mironiasty mironiasty changed the title [FCE-571] Update readme [FCE-571] Update readme and typedoc Sep 24, 2024
Copy link

linear bot commented Sep 25, 2024

@fishjam-cloud fishjam-cloud deleted a comment from linear bot Sep 25, 2024
Copy link
Contributor

@karkakol karkakol left a comment

Choose a reason for hiding this comment

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

looks good for me 👍

@mironiasty mironiasty merged commit 6a51596 into main Sep 25, 2024
2 checks passed
@mironiasty mironiasty deleted the update-readme2 branch September 25, 2024 14:21
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.

3 participants