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

Use GH pages for auto-generated docs #68

Merged
merged 4 commits into from
Nov 24, 2023
Merged

Conversation

MassimilianoLattanzio
Copy link
Collaborator

Instead of basic .md files in the repository, we want to use GH pages to create a website to show the cop's documentation.

Preview here: https://solidusio.github.io/rubocop-solidus/

Closes #65.

In this way, it will be loaded automatically by GH pages.
In this way we can show a back button instead of unuseful repo buttons.
@MassimilianoLattanzio MassimilianoLattanzio added the documentation Improvements or additions to documentation label Nov 24, 2023
@MassimilianoLattanzio MassimilianoLattanzio self-assigned this Nov 24, 2023
Copy link
Collaborator

@safafa safafa left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏼

@MassimilianoLattanzio MassimilianoLattanzio merged commit a9135c4 into main Nov 24, 2023
7 checks passed
@MassimilianoLattanzio MassimilianoLattanzio deleted the ml/gh-pages branch November 24, 2023 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move auto-generated docs to GH pages instead of .md files
3 participants