Ryukijano / Qiskit_on_Qubit

1 stars 0 forks source link

Add Jekyll site for GitHub Pages #3

Open Ryukijano opened 2 weeks ago

Ryukijano commented 2 weeks ago

Add Jekyll configuration, content, and structure for the GitHub Pages site.


For more details, open the Copilot Workspace session.

Summary by Sourcery

Set up a Jekyll site for GitHub Pages with configuration, content, and structure, including a homepage, default layout, and custom CSS. Add tests to ensure the site functions correctly by checking for broken links and missing assets.

New Features:

Enhancements:

Documentation:

Tests:

sourcery-ai[bot] commented 2 weeks ago

Reviewer's Guide by Sourcery

This PR implements a GitHub Pages site using Jekyll, setting up the basic structure and configuration for hosting documentation. The implementation includes Jekyll configuration, layout templates, styling, and automated testing.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Configure Jekyll site settings and plugins
  • Set up site metadata including title, description, and base URL
  • Configure Jekyll theme to use modernist
  • Enable multiple Jekyll plugins for enhanced functionality
  • Define author information
docs/_config.yml
Implement default layout template for consistent page structure
  • Create HTML structure with header, navigation, main content, and footer
  • Add navigation menu with links to all project sections
  • Include dynamic title and author information
  • Link stylesheet for styling
docs/_layouts/default.html
Create homepage with project overview
  • Set up markdown-based homepage with project introduction
  • Add navigation links to all major sections
  • Configure front matter for layout and title
docs/index.md
Implement custom CSS styling
  • Define base styles for typography and layout
  • Style header and navigation components
  • Create responsive layout structure
  • Add footer styling
docs/assets/css/styles.css
Add automated testing for site validation
  • Implement tests for homepage accessibility
  • Add broken link checking
  • Create tests for missing assets
  • Set up test class structure with setUp method
tests/test_site.py

Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).