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.

Sign up for GitHub

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

Jump to bottom

Merge Wiki and README into a GitHub Pages site #871

Closed
scarroll32 opened this issue Feb 6, 2018 · 4 comments · Fixed by #1291
Closed

Merge Wiki and README into a GitHub Pages site #871

scarroll32 opened this issue Feb 6, 2018 · 4 comments · Fixed by #1291
Assignees
@scarroll32
Labels
Documentation

Comments

@scarroll32
Copy link
Member

scarroll32 commented Feb 6, 2018 •
edited
Loading

Update - 10/3/22

  • Launch a GitHub pages site for Ransack based on just-the-docs, similair to ViewComponents
  • Move in and reformat useful material from the Wiki
  • Move all project information from the README into the pages site
  • Change the README to be quite concise

Original proposal

I'm proposing here that we cleanup and merge the Wiki into the Readme.

Why?

  • A single location for documentation, with up to date material only.
  • The Ransack docs could use a review
  • Acknowledgement for documentation work via PRs, where Wiki changes are in the Wiki repo which gets unnoticed.
  • Automatically deployed to Rubydocs
  • Will be part of the 3.0.0 release

Thoughts from the community?
@seanlinsley
Copy link
Contributor

➕ from me. I've always disliked using wikis for documentation in open source projects.

@scarroll32 scarroll32 mentioned this issue Feb 24, 2021
Closed
13 tasks
@scarroll32 scarroll32 self-assigned this Mar 10, 2022
@scarroll32 scarroll32 changed the title Proposal: Merge Wiki into README Merge Wiki and README into a GitHib Pages site Mar 10, 2022
@scarroll32
Copy link
Member Author

@deivid-rodriguez FYI, I'll get a branch out with this over the coming weekend.

@deivid-rodriguez
Copy link
Contributor

Sounds great!

@scarroll32 scarroll32 changed the title Merge Wiki and README into a GitHib Pages site Merge Wiki and README into a GitHub Pages site Mar 27, 2022
@scarroll32
Copy link
Member Author

Update

I'm working on a Docusaurus site which includes a blog, should be running very soon. 🤞

@scarroll32 scarroll32 mentioned this issue Mar 28, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@scarroll32 scarroll32

Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Move documentation into Docusaurus activerecord-hackery/ransack
3 participants
@seanlinsley @deivid-rodriguez @scarroll32