Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed 3 broken links, 1 still needs fixing. #2924

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Thrizian
Copy link

@Thrizian Thrizian commented Jun 7, 2024

What is this pull request for?

This fixes broken links.

Except for one, in menus.yml.tt, I've added a todo for that because this readme does not exist? Should/Does it? It's not available at the moment and i needed it. Because i have no clue how to make menus just yet.

Notable changes (remove if none)

Fixed links in comments.

Checklist

  • I have followed Pull Request guidelines
  • I have added a detailed description into each commit message
  • I have added tests to cover this change

@Thrizian Thrizian requested a review from a team as a code owner June 7, 2024 09:24
Copy link

codecov bot commented Jun 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.97%. Comparing base (efb901e) to head (3c1f4b2).
Report is 134 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2924   +/-   ##
=======================================
  Coverage   95.97%   95.97%           
=======================================
  Files         232      232           
  Lines        6279     6279           
=======================================
  Hits         6026     6026           
  Misses        253      253           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@tvdeyen tvdeyen left a comment

Choose a reason for hiding this comment

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

Thanks. I think we should remove the link to menu guides for now.

@@ -1,6 +1,7 @@
# == In this configuration, you set up Alchemy's menu names.
#
# For further information please see http://guides.alchemy-cms.com/stable/menus.html
# TODO: Ensure there is a working link with explanation on how menu's are constructed. Link below is broken.
# For further information please see http://guides.alchemy-cms.com/menus.html
Copy link
Member

Choose a reason for hiding this comment

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

There is no guide unfortunately. Can we remove the comment altogether for now?

Choose a reason for hiding this comment

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

I am a new person testing out Alchemy having this undocumented is super confusing as this is very core to any webpage.

After looking a bit on the code I found what to do.

What about instead having the links say: To create the views for the menu use rails g alchemy:menus and render the menu with <%= render_menu('menu_name') %>

At least this comment with get the people going for common use cases.

Copy link

This pull request has not seen any activiy in a long time.
Probably because of missing tests or a necessary rebase.
This PR will be closed in 7 days if no further activity happens.

@github-actions github-actions bot added Stale and removed Stale labels Aug 27, 2024
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