Skip to content

Conversation

@coiseiw
Copy link
Collaborator

@coiseiw coiseiw commented Aug 20, 2025

Style edition for changelog and FAQ page

Also modifying the answer to the first FAQ question to reflect the new install process

…swer to the installation question in the FAQ.

Moving the footer.html page inside the doc folder.
…swer to the installation question in the FAQ.

Moving the footer.html page inside the doc folder.
@coiseiw coiseiw requested review from Copilot and s3inlc August 20, 2025 07:14
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR applies style improvements to the documentation, specifically updating the changelog and FAQ page formatting to use consistent styling. The main purpose is to enhance visual presentation and update installation guidance.

  • Standardizes FAQ question formatting with styled HTML spans for better visual hierarchy
  • Converts changelog heading structure from inconsistent markdown to uniform HTML styling
  • Updates the first FAQ answer to reference Docker installation instead of manual setup

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.

File Description
mkdocs.yml Updates custom directory path for theme overrides
doc/user_manual/crackers_binary.md Fixes grammar error ("other cracker" to "other crackers")
doc/faq_tips/faq.md Reformats all FAQ questions with HTML styling and updates installation answer
doc/changelog.md Standardizes all section headings with consistent HTML styling

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@s3inlc s3inlc merged commit c0e6488 into dev Aug 20, 2025
2 checks passed
@s3inlc s3inlc deleted the docs-fix branch August 20, 2025 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants