Skip to content

feat(docs): add VitePress documentation #9463

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
Merged
Bas950 merged 51 commits into from
Aug 10, 2025
Merged

feat(docs): add VitePress documentation #9463

Bas950 merged 51 commits into from
Aug 10, 2025

Conversation

@Timeraa
Copy link
Member

@Timeraa Timeraa commented Apr 6, 2025 •
edited
Loading

Description

This PR adds comprehensive documentation for PreMiD Activity development using VitePress.

Features

  • Complete guide for creating and testing activities
  • API reference documentation
  • Example activities
  • Improved navigation and organization
  • TypeScript configuration for VitePress
  • Placeholder images for future screenshots
  • GitHub Pages deployment workflow
  • PR preview deployments for documentation changes
  • Proper JSON formatting in code blocks
  • ESLint compatibility with TypeScript code blocks

Notes

  • This is a draft PR as some sections still need to be completed
  • Screenshots will need to be added to replace placeholders
  • Some API documentation sections need to be filled in

Related Issue

N/A

Type of change

  • New feature (non-breaking change which adds functionality)
  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

github-advanced-security[bot]
github-advanced-security bot found potential problems Apr 6, 2025
View reviewed changes
Copy link

@github-advanced-security github-advanced-security bot left a comment

Choose a reason for hiding this comment

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

ESLint found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

github-advanced-security[bot]
github-advanced-security bot found potential problems Apr 6, 2025
View reviewed changes
@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 6, 2025 15:31 — with GitHub Actions Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025 •
edited
Loading

📝 Documentation Preview

Your documentation changes are ready for preview!

🔍 View Preview

This preview will be automatically updated when you push new commits to this PR.

@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 6, 2025 15:39 — with GitHub Actions Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

📝 Documentation Preview

Your documentation changes are ready for preview!

🔍 View Preview

This preview will be automatically updated when you push new commits to this PR.

@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 6, 2025 15:41 — with GitHub Actions Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

📝 Documentation Preview

Your documentation changes are ready for preview!

🔍 View Preview

This preview will be automatically updated when you push new commits to this PR.

@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 6, 2025 16:04 — with GitHub Actions Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

📝 Documentation Preview

Your documentation changes are ready for preview!

🔍 View Preview

This preview will be automatically updated when you push new commits to this PR.

@Timeraa Timeraa force-pushed the docs/vitepress-documentation branch from b906554 to b6b6f3a Compare April 6, 2025 16:09
@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 6, 2025 16:09 — with GitHub Actions Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

📝 Documentation Preview

Your documentation changes are ready for preview!

🔍 View Preview

This preview will be automatically updated when you push new commits to this PR.

@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 6, 2025 16:16 — with GitHub Actions Inactive
@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 6, 2025 17:31 — with GitHub Actions Inactive
DarkVillager

This comment was marked as outdated.

Sign in to view

@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 9, 2025 11:12 — with GitHub Actions Inactive
@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 9, 2025 11:19 — with GitHub Actions Inactive
github-advanced-security[bot]
github-advanced-security bot found potential problems Apr 9, 2025
View reviewed changes
@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 9, 2025 11:23 — with GitHub Actions Inactive
@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 9, 2025 11:28 — with GitHub Actions Inactive
@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 9, 2025 11:40 — with GitHub Actions Inactive
@joerkig
Copy link
Contributor

joerkig commented Apr 9, 2025

https://premid.github.io/Activities/v1/guide/best-practices.html#comment-your-code

The level of commenting feels a bit over the top in the "good" example

@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 15, 2025 20:04 — with GitHub Actions Inactive
@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 15, 2025 21:50 — with GitHub Actions Inactive
github-advanced-security[bot]
github-advanced-security bot found potential problems Apr 15, 2025
View reviewed changes
@Timeraa
Copy link
Member Author

Timeraa commented Apr 16, 2025

https://premid.github.io/Activities/v1/guide/best-practices.html#comment-your-code

The level of commenting feels a bit over the top in the "good" example

Updated, let me know if that's better

@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 16, 2025 14:45 — with GitHub Actions Inactive
@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 16, 2025 14:57 — with GitHub Actions Inactive
@Timeraa Timeraa temporarily deployed to preview-pr-9463 April 16, 2025 15:45 — with GitHub Actions Inactive
Timeraa and others added 17 commits August 7, 2025 19:25
@Timeraa @Bas950
chore: review comments
662994e
@Timeraa @Bas950
docs: fix getPageVariable example and update utility functions to use…
232d547 
… Assets enum
@Timeraa @Bas950
docs: improve getPageVariable example with proper destructuring and t…
720966b 
…ype annotations
@Timeraa @Bas950
chore: add forwarding to sidebar
bb69698
@Timeraa @Bas950
chore: lint
215f30a
@Timeraa @Bas950
chore: enable search and add special episode formatting
873d1fa
@Timeraa @Bas950
chore: lint
6ea68d1
@Timeraa @Bas950
fix: update URL references to use document.location.href instead of d…
8575b15 
…ocument.URL
@Timeraa @Bas950
Add tape recordings for creating and developing activities
c74846d 
- Created a new tape for the activity creation process, capturing the command execution and user inputs.
- Added a tape for the activity development process, documenting the command and a pause for observation.
@Timeraa @Bas950
fix: update create-activity tape to include user ID input
0cff945
@Timeraa @Bas950
fix: update description for timestamp setting to clarify functionality
d9b6270
@Timeraa @Bas950
chore: update stuff
bdf2c6d
@Bas950
fix: browsingTimestamp and ActivityAssets
d50ce1f
@Bas950
feat: dep updates, favicon, allowURLOverrides
bf8a203
@Bas950
feat: new presencedata fields
49cb80e
@Bas950
chore: lint
990fa84
@Bas950
chore: lint
28e7692
@Bas950 Bas950 force-pushed the docs/vitepress-documentation branch from 3479284 to 28e7692 Compare August 7, 2025 17:25
@Bas950 Bas950 enabled auto-merge (squash) August 7, 2025 17:26
@DarkVillager
Copy link
Contributor

DarkVillager commented Aug 8, 2025

I'm no longer interested in reviewing this pr.

@Bas950
Copy link
Member

Bas950 commented Aug 10, 2025

I'm no longer interested in reviewing this pr.

yea sorry, just wanted to get your requested changes away.

@Bas950 Bas950 merged commit b015329 into main Aug 10, 2025
10 checks passed
@Bas950 Bas950 deleted the docs/vitepress-documentation branch August 10, 2025 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@theusaf theusaf theusaf approved these changes

@Bas950 Bas950 Bas950 approved these changes

@DarkVillager DarkVillager Awaiting requested review from DarkVillager

Assignees

No one assigned

Labels

repo maintenance General repo maintenance, including updating tools etc

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Timeraa @joerkig @DarkVillager @Bas950 @theusaf