Documentation

[FerdinandSu]

Hi, I'm the developer of this Program, but I don't have enough time to make my program perfect. I'll appreciate it if you can help me improve it and become a contributor. Here is an existing issue:

This project lacks detailed documentation, please help me fill in
本项目缺乏完备的文档，请帮助我完善。

TODO:

1. Update existing documentation in the project to "Sphinx Format", the current format cannot generate valid Sphinx documentation.
2. Use sphinx-docfx + docfx to create a documentation site, refer to the JMobileSuit implementation (Writing blog article).
3. Write articles in docs/articles, refer to the MobileSuit Docs.

Finishing any of the steps is OK to make a PR.

[FerdinandSu]

Please don't hesitate to ask me questions; also, leave comments before you start your work to avoid duplicated work.

如果你有任何疑问，欢迎留言询问我；请在开始前在此留言，防止他人进行重复的工作。

[FerdinandSu]

For subsequent contributors:

1. Regarding the addition of documents for JMobileSuit, it is necessary to temporarily submit (PR) them to the src branch of the Plastic-Metal.github.io. Currently, JMobileSuit's documents are hosted here (please note that JMobileSuit has undergone a major update in version 1.0, and much of the content may be outdated and may need to be combined with your own practice.

2. Regarding the addition of documents for MobileSuit, please submit the relevant changes directly to its own repository, whose documents are built based on docfx. Place the documents towards the correct place.

3. Regarding the addition of documents for PyMobileSuit, the Markdown file can be temporarily placed in the /docs directory of its own repository

对于后续的贡献者：

1. 针对JMobileSuit的文档增加，需要暂时提交到Plastic-Metal.github.io仓库的src分支，目前JMobileSuit的文档被托管于此。请注意，JMobileSuit目前经历了1.0版本的大型更新，许多内容可能已经是过时的，可能需要结合你自己的实践。
2. 针对MobileSuit的文档增加，请直接向他自己的代码仓库提交相关更改，它的文档基于docfx构建，请参考相关配置放置文档。
3. 针对PyMobileSuit的文档增加，可以暂时把Markdown文件放在仓库的/docs目录下直接向他自己的代码仓库PR。

[FerdinandSu]

Documentation has been significantly improved:

✅ Completed:

• Updated README with comprehensive features, getting started guide, and relationship with MobileSuit .NET
• Created CONTRIBUTING.md with comprehensive contribution guidelines in both English and Chinese
• Created issue templates in .github/issues/ for structured contributions
• Added feature parity tracking in .claude/MobileSuitFeatures.md
• Established clear project structure and coding standards

📋 Remaining tasks (tracked in separate issues):

• Sphinx API documentation generation
• Tutorial series (see new issues Create Project Templates #25, Implement Interactive Selection Components #27, etc.)
• More code examples in examples/ directory
• Video tutorials (future consideration)

The documentation infrastructure is now in place. Specific documentation tasks are being tracked in separate, more focused issues for better community contribution.

This issue remains open to track overall documentation improvements.