JeremyYao commented on issue #1412: URL: https://github.com/apache/daffodil-vscode/issues/1412#issuecomment-3766962362
> Design for moving the md files into Doc folder: > > Me and [@CoverRyan](https://github.com/CoverRyan) decided its best to move the wiki file (https://github.com/apache/daffodil-vscode/wiki/Apache-Daffodil%E2%84%A2-Extension-for-Visual-Studio-Code:-v1.5.0) as well as the beginner's guide (https://github.com/apache/daffodil-vscode/wiki/Introduction-to-Daffodil-VS-Code-Extension) into the doc folder as MD files. > > With each ticket that's in review, and if deemed that it needs documentation, the developer will add documentation to the wiki md file. > > At the end of each version release, we're going to look at the tickets that needed documentation and review the wiki md files for one last time. > > Then, once everything is finalized, a new wiki page will be created for the latest version that contains the information from the wiki md file. It sounds like we're moving the latest version's user documentation and the beginner's guides to the docs folder while keeping the process very similar to what we have. I have no objections to the proposal. I do want to propose some additions - Edit the PR template to point to where developers should put documentation (eg: docs/latest_version_1.X.X.X.md) specifically for the checkbox tip. This would aid with new developers making contributions by giving them more specific directions -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
