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

Move README content into code as TypeDoc #50

Open
steveluscher opened this issue Jan 4, 2025 · 0 comments
Open

Move README content into code as TypeDoc #50

steveluscher opened this issue Jan 4, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@steveluscher
Copy link
Collaborator

steveluscher commented Jan 4, 2025 •
edited
Loading

  • Familiarize yourself with TypeDoc Tags https://typedoc.org/documents/Tags.html
  • Preview the documentation by running pnpm turbo compile:ghpages --output-logs=errors-only and python3 -m http.server -d docs in a separate terminal
  • Upload the docs somewhere and attach the link to your PR (eg. upload a ZIP through https://app.netlify.com/)
  • Submit one or more PR per package
@steveluscher steveluscher added the enhancement New feature or request label Jan 4, 2025
steveluscher added a commit that referenced this issue Jan 4, 2025
@steveluscher
Document @solana/addresses with TypeDoc
Loading
Loading status checks…
a7aa081 
Addresses #50
@steveluscher steveluscher mentioned this issue Jan 4, 2025
Merged
steveluscher added a commit that referenced this issue Jan 4, 2025
@steveluscher
Document @solana/accounts with TypeDoc
Loading
Loading status checks…
bb0abcd 
Addresses #50
steveluscher added a commit that referenced this issue Jan 7, 2025
@steveluscher
Document @solana/accounts with TypeDoc
Loading
Loading status checks…
b3a5bc7 
Addresses #50
steveluscher added a commit that referenced this issue Jan 14, 2025
@steveluscher
Document @solana/accounts with TypeDoc (#51)
Loading
Loading status checks…
e68945b 
This PR moves content from the `README` into the code.

Preview here: https://illustrious-gumption-b4d2fe.netlify.app/modules/_solana_accounts.html

Addresses #50
This was referenced Jan 16, 2025
Merged
Merged
Merged
Merged
steveluscher added a commit that referenced this issue Jan 20, 2025
@steveluscher
Document @solana/errors with TypeDoc (#66)
Loading
Loading status checks…
67841ac 
This PR moves content from the README into the code.

Addresses #50

# Test Plan

```shell
cd packages/errors
pnpm typedoc --watch \
  --plugin typedoc-plugin-missing-exports \
  --plugin typedoc-plugin-mdn-links
python3 -m http.server -d docs
```

Preview here: https://silly-creponne-8b5941.netlify.app/
@lorisleiva lorisleiva mentioned this issue Jan 24, 2025
Merged
steveluscher pushed a commit that referenced this issue Jan 31, 2025
@lorisleiva
Document @solana/signers with TypeDoc (#78)
Loading
Loading status checks…
5a6a463 
This PR moves content from the README into the code.

Addresses #50

# Test Plan

```shell
cd packages/signers
pnpm typedoc --watch --plugin typedoc-plugin-missing-exports
python3 -m http.server -d docs
```

Preview here: https://boisterous-alfajores-c0ea79.netlify.app/
This was referenced Feb 10, 2025
Merged
Merged
Merged
Merged
Merged
steveluscher pushed a commit that referenced this issue Feb 19, 2025
@lorisleiva
Document @solana/codecs-core with TypeDoc (#105)
Loading
Loading status checks…
d981013 
This PR adds TypeDoc-compatible docblocks to all items inside the `codecs-core` package.

Addresses #50

# Test Plan

```shell
cd packages/codecs-core
pnpm typedoc --watch --plugin typedoc-plugin-missing-exports
python3 -m http.server -d docs
```

Preview here: https://sage-froyo-f89394.netlify.app/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@steveluscher