Skip to content

Added introduction page#206

Merged
joaquinvanschoren merged 1 commit intomainfrom
add-intro
Oct 21, 2024
Merged

Added introduction page#206
joaquinvanschoren merged 1 commit intomainfrom
add-intro

Conversation

@joaquinvanschoren
Copy link
Contributor

@joaquinvanschoren joaquinvanschoren commented Oct 21, 2024

Summary by Sourcery

Documentation:

  • Add an introduction page to the navigation menu in the documentation.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Oct 21, 2024

Reviewer's Guide by Sourcery

This pull request adds an introduction page to the documentation by updating the navigation structure in the mkdocs.yml file.

User journey diagram for the updated documentation navigation

journey
    title User journey for accessing the introduction page
    section Accessing Documentation
      User: Navigate to Documentation
      User: See Introduction Page
      User: Click on Introduction Page
      User: Read Introduction Content
Loading

File-Level Changes

Change Details Files
Added a new 'Intro' page to the documentation navigation
  • Inserted a new navigation item for the 'Intro' page
  • Set the 'Intro' page to use 'index.md' as its source file
mkdocs.yml

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 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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @joaquinvanschoren - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@joaquinvanschoren joaquinvanschoren merged commit 217d62d into main Oct 21, 2024
@joaquinvanschoren joaquinvanschoren deleted the add-intro branch October 21, 2024 21:43
@PGijsbers
Copy link
Contributor

I hadn't merged it yet since I was planning to check how to roll it into the "OpenML Server" item at the top of the list. Similar to "setup" on this page.

@joaquinvanschoren
Copy link
Contributor Author

Sorry, I thought you were just too busy with other projects at the moment. Feel free to move it.

@PGijsbers
Copy link
Contributor

It's fine. It doesn't really hurt anything. Now I'll just open an issue so I don't forget about it.

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.

2 participants