diff --git a/changelog.md b/changelog.md index a957dcb..c92779a 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,11 @@ # Changelog +## 2025-01-14 - 1.4.3 - fix(aidocs_classes) +Improve readme generation instructions to ensure correct markdown formatting. + +- Added guidance to avoid using backticks at the beginning and end of readme generation to prevent markdown issues. +- Clarified that the output is directly written to readme.md and backticks should only be used for code blocks. + ## 2024-10-28 - 1.4.2 - fix(cli) Ensure async completion for aidoc readme and description generation diff --git a/ts/00_commitinfo_data.ts b/ts/00_commitinfo_data.ts index b4d9a7a..df6cf11 100644 --- a/ts/00_commitinfo_data.ts +++ b/ts/00_commitinfo_data.ts @@ -3,6 +3,6 @@ */ export const commitinfo = { name: '@git.zone/tsdoc', - version: '1.4.2', + version: '1.4.3', description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.' } diff --git a/ts/aidocs_classes/readme.ts b/ts/aidocs_classes/readme.ts index 2e69780..150acde 100644 --- a/ts/aidocs_classes/readme.ts +++ b/ts/aidocs_classes/readme.ts @@ -127,6 +127,8 @@ The Readme should follow the following template: Good to know: * npmextra.json contains overall module information. * readme.hints.md provides valuable hints about module ideas. + * Your output lands directly in the readme.md file. + * Don't use \`\`\` at the beginning or the end. It'll cause problems. Only use it for codeblocks. You are directly writing markdown. No need to introduce it weirdly. ] `, messageHistory: [],