如何更新项目文档
- 需要用Visual Studio+Reshaper, 把每个文档都加上namespace。
- 一步步按照这个repo来:https://github.com/NormandErwan/DocFxForUnity
- 在filterConfig文件中排除其他namespace。
- 在本地运行:docfx Documentation/docfx.json --serve之后,把.site文件夹移入Documentation中。
- 需要把.github文件夹放入Documentation文件夹。
- 更改documentation.yml,注意不要删除xref。UnityXrefMaps应该是你的repo的名称。
- push到github main分支,这里要去setting里的secret,创建自己的secret,并且在documentation.yml里做相应更改。
- 在github action中查看build和deploy有无错误。如果没有错误,那么应该可以在https://pren1.github.io/Documentation/看到你的项目文档。