Skip to content

Conversation

0xrinegade
Copy link

@0xrinegade 0xrinegade commented Jul 26, 2025

Screenshot_2025-07-26_21-14-55 This pull request introduces significant enhancements to the documentation and deployment workflows for the VTable project. The changes focus on improving English-language support, providing comprehensive examples, and enabling automated deployment to GitHub Pages. Below is a summary of the most important changes:

Documentation Enhancements

  • English Documentation (docs/en/README.md, docs/en/getting-started.md): Added detailed guides, API references, and examples for English-speaking users, covering installation, basic usage, advanced features, framework integrations, and troubleshooting. [1] [2]
  • English Demo Section (README.md, english-demo/README.md): Introduced a dedicated English demo section with interactive examples, including basic table setup, advanced features, and performance optimization. [1] [2]

Deployment Workflow

  • Static Content Deployment (.github/workflows/static.yml): Added a GitHub Actions workflow to automate the deployment of static content (e.g., English demos) to GitHub Pages, ensuring streamlined updates for documentation and examples.

demo:
https://0xrinegade.github.io/VTable/

@fangsmile
Copy link
Contributor

0 VisActor飞书群永久有效 Can you join our group of feishu lark app? I want to comunicate with you on your pr.

@0xrinegade
Copy link
Author

hey im sorry im dont have this app, but you can ping me on t.me/rinegade_dev

@fangsmile
Copy link
Contributor

I have reviewed all HTML page content, and I find that many page functions do not respond when clicked. Are you using a fully AI-generated webpage? Additionally, I feel that this webpage lacks specific significance, as our components already have an official website for comprehensive introduction.
If you are interested in our project, you can help by writing promotional articles for foreign technical content websites, or by fixing issues on GitHub and submitting pull requests. Alternatively, you can also help by writing examples of other business scenarios in the docs/assets/demo directory. @0xrinegade

@0xrinegade
Copy link
Author

@fangsmile hey indeed you very correct about this one, let me fix them, i dont have any intention to replace existing website and docs, i think they are fine in own way, its more an intent to add alternative docs just for the sake of better indexing by search engines therefore next versions of AI models will have more knowledge on how to use vtable, im doing it not just randomly or coz im a fan of tables, its just i decided to use vtable coz i find it best one from all available, but found out that its lacking of docs therefore AI agents struggle with using it, thats why i also created llms.txt

writing articles or tech content is great i might write one about how im using it for opensvm.com once i finish it

Add Russian demo and documentation support to VTable
@0xrinegade 0xrinegade changed the title attempt to improve eng docs WIP: attempt to improve eng docs Jul 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants