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

DOC fix and clean up documentation links #1341

Open
wants to merge 3 commits into
base: 6
Choose a base branch
from

Conversation

isoeli
Copy link

@isoeli isoeli commented Oct 24, 2024

  • Fixed relative paths in features section
  • Removed link to non-existent markdown file

Fixed relative paths in features section
Removed link to non-existent markdown file
Fixed relative paths in features section
Removed link to non-existent markdown file
Copy link
Member

@GuySartorelli GuySartorelli left a comment

Choose a reason for hiding this comment

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

Other than the one link to a file that no longer exists, these links are correct. The documentation is used to generate this userhelp site which has its own link handling functionality.

Strictly speaking the .md should be removed per the contribution guidelines so if you'd like to update them to match that style I'd be greatful.

Otherwise feel free to close this PR if you only wanted to update the links for viewing the markdown in GitHub as that isn't the recommended way to view them.

- Adjusted links according to the contribution guidelines for documentation
- Removed link to non-existent markdown file
@isoeli
Copy link
Author

isoeli commented Nov 14, 2024

@GuySartorelli Thank you for the explanation, and I apologize for the PR! This was my first time using SilverStripe, and to understand how the user form works, I cloned it locally and reviewed the code in my IDE. Since I hadn’t checked the documentation online, I got a bit mixed up about the link structure. I thought updating the links might help others avoid similar issues, so I went ahead with the PR. Sorry for that mistake..

I’ve now updated the links based on the contribution guidelines.

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