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

Missing TypeDoc Documentation for @coral-xyz/anchor-cli Package #3402

Open
savvar9991 opened this issue Dec 3, 2024 · 1 comment
Open

Missing TypeDoc Documentation for @coral-xyz/anchor-cli Package #3402

savvar9991 opened this issue Dec 3, 2024 · 1 comment

Comments

@savvar9991
Copy link

Description

The TypeDoc documentation for the @coral-xyz/anchor-cli package is currently inaccessible. The link in the main README.md points to a non-existing location.

Current Situation

Expected Behavior

  • TypeDoc documentation for CLI package should be accessible
  • Documentation should be consistent with other TypeScript packages
  • Link should point to valid TypeDoc generated documentation

Additional Context

Proposed Solution

Either:

  1. Regenerate and publish TypeDoc documentation for CLI package
  2. Update documentation links to point to correct location
  3. Or update README to point to main documentation if TypeDoc is no longer maintained

Related

Let me know if you need any additional information or clarification.

@savvar9991
Copy link
Author

Closing this issue as we're addressing this along with other documentation improvements in PR #1.
The PR includes:

  • Documentation link fixes (TypeDoc -> main docs)
  • File structure improvements
  • Typo corrections (HTML attributes, text hyphenation)

You can track the progress here: Eclipse-Laboratories-Inc#1

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

No branches or pull requests

1 participant