New documentation website with fssg framework #10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… anchors, and format HTML builder docs - Add `cleanupOnFailure` method to `projectGenerator` in `new` command to remove partial project dirs on error, with verbose logging - Handle `flag.ErrHelp` in CLI `Run` for graceful global and command-specific help display (e.g., `-h` or `--help`) - Update `gendoc` command: simplify output default to "reference.md" and add `-o` alias - Refactor `generateReferenceMarkdown`: use `doc.New` for simpler package doc creation, introduce `generateTOC` for dynamic table of contents, improve anchor generation (e.g., collapse multiple hyphens, trim edges), and enhance `formatDocText` with `doc.ToHTML` + basic MD conversion for better list/code handling - Update `writeDocItem` for consistent anchor/ID placement and Go code block rendering - Format all doc comments in `html.go` to use Markdown inline code (e.g., `<div>` → `` `<div>` ``) for consistency - Add/update tests in `refparser_test.go`: adjust assertions for new TOC structure (e.g., method headers as `####`), more anchor edge cases, and code fence checks These changes improve error recovery, user experience in CLI/help, and documentation quality/output.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Built the new website with fssg