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

[Fix #199] Fix the homepage URI #201

Merged
merged 1 commit into from
Feb 18, 2020
Merged

Conversation

koic
Copy link
Member

@koic koic commented Feb 18, 2020

Fixes #199.

This PR fixes the homepage URI.


Before submitting the PR make sure the following are checked:

  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.

Fixes rubocop#199.

This PR fixes the homepage URI.
@andyw8
Copy link
Contributor

andyw8 commented Feb 18, 2020

Perhaps also worth adding to the README?

@koic
Copy link
Member Author

koic commented Feb 18, 2020

That is a good idea! It will help users if added like the RuboCop core.
https://github.com/rubocop-hq/rubocop#documentation

@koic koic merged commit 40e507b into rubocop:master Feb 18, 2020
@koic koic deleted the fix_homepage_uri branch February 18, 2020 03:36
koic added a commit to koic/rubocop-rails that referenced this pull request Feb 18, 2020
Follow up of rubocop#201 (comment).

This PR adds documentation link to README.md.
koic added a commit to koic/rubocop-rails that referenced this pull request Feb 18, 2020
Follow up of rubocop#201 (comment).

This PR adds a documentation link to README.md.
@koic koic mentioned this pull request Feb 18, 2020
8 tasks
bbatsov pushed a commit that referenced this pull request Feb 18, 2020
Follow up of #201 (comment).

This PR adds a documentation link to README.md.
@bbatsov
Copy link
Contributor

bbatsov commented Feb 18, 2020

Nice catch! It's pretty weird this doesn't work without the trailing slash. Oh, well... One more argument to abandon ReadTheDocs at some point.

@koic
Copy link
Member Author

koic commented Feb 18, 2020

Sure. ReadTheDocs may have changed. I have no opinion as there is no knowledge of a services that provide documentation.

@bbatsov
Copy link
Contributor

bbatsov commented Feb 18, 2020

@koic I've migrated a while ago one of my other major projects to Antora (AsciiDoc) and I've been pretty happy with the results (see https://docs.cider.mx). Notice is the menu how you can easily switch between the docs for related projects and how much better doc search is. That's also why I moved the style guides from Markdown to AsciiDoc (btw, these days the canonical AsciiDoc implementation is written in Ruby, which is pretty cool). The only real problem is that converting between the two formats is a lot of work, as the auto-conversion is not precise and we'd have to update the cop docs generation logic as well.

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.

Homepage in gemspec seems incorrect
3 participants