Skip to content

Conversation

@grzanka
Copy link
Contributor

@grzanka grzanka commented Mar 27, 2025

This pull request involves a significant overhaul of the documentation, including the removal of tutorial content and the addition of new library documentation. It also includes changes to the site configuration and layout.

Documentation Overhaul:

  • docs/intro.md: Removed the entire introductory tutorial content.
  • docs/library/intro.md: Added comprehensive documentation for the libamtrack C Library, including links to the GitHub repository and various documentation resources.

Site Configuration and Layout:

Other Documentation Changes:

  • Removed various tutorial markdown files, including create-a-blog-post.md, create-a-document.md, create-a-page.md, deploy-your-site.md, markdown-features.mdx, manage-docs-versions.md, and translate-your-site.md. [1] [2] [3] [4] [5] [6] [7]
  • Removed category JSON files for tutorials. [1] [2]

@grzanka grzanka linked an issue Mar 27, 2025 that may be closed by this pull request
@grzanka grzanka self-assigned this Mar 27, 2025
@grzanka grzanka requested a review from Copilot March 27, 2025 09:05
Copy link
Contributor

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 pull request overhauls the documentation structure and updates the site configuration while updating the favicon to a new SVG format. Key changes include:

  • Simplifying the homepage title by removing the greeting prefix.
  • Updating the favicon in the site configuration and cleaning up social and blog-related references.
  • Removing several tutorial markdown files and introducing comprehensive documentation for the libamtrack C Library.

Reviewed Changes

Copilot reviewed 18 out of 21 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/pages/index.tsx The homepage title is simplified by removing the greeting prefix.
docusaurus.config.ts The favicon update from favicon.ico to favicon.svg is applied and unused social/blog configurations are removed.
docs/tutorial-extras/translate-your-site.md Removal of the translate-your-site tutorial file.
docs/tutorial-extras/manage-docs-versions.md Removal of the docs version management tutorial.
docs/tutorial-basics/deploy-your-site.md Removal of the deploy-your-site tutorial file.
docs/tutorial-basics/create-a-page.md Removal of the create-a-page tutorial file.
docs/tutorial-basics/create-a-document.md Removal of the create-a-document tutorial file.
docs/tutorial-basics/create-a-blog-post.md Removal of the create-a-blog-post tutorial file.
docs/tutorial-basics/congratulations.md Removal of the congratulations tutorial file.
docs/library/intro.md Introduction of detailed documentation for the libamtrack C Library.
docs/library/index.md Removal of an existing placeholder file.
docs/intro.md Removal of the introductory tutorial content.
Files not reviewed (3)
  • docs/tutorial-basics/category.json: Language not supported
  • docs/tutorial-basics/markdown-features.mdx: Language not supported
  • docs/tutorial-extras/category.json: Language not supported
Comments suppressed due to low confidence (2)

src/pages/index.tsx:36

  • [nitpick] The removal of the greeting 'Hello from' alters the page title style; please confirm that this simplification aligns with the overall design goals for the homepage title.
+      title={`${siteConfig.title}`}

docusaurus.config.ts:10

  • Ensure that the new favicon file (img/favicon.svg) exists and is deployed correctly to prevent a broken favicon on the site.
+  favicon: 'img/favicon.svg',

@grzanka grzanka merged commit e667204 into main Mar 27, 2025
5 checks passed
@grzanka grzanka deleted the 11-add-proper-favicon branch March 27, 2025 09:10
@grzanka grzanka mentioned this pull request Mar 27, 2025
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.

Add proper favicon

2 participants