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

Docs cleanup #320

Merged
merged 3 commits into from
May 21, 2024
Merged

Docs cleanup #320

merged 3 commits into from
May 21, 2024

Conversation

alexander-yakushev
Copy link
Contributor

@alexander-yakushev alexander-yakushev commented May 20, 2024

I've tried to clean up some docs on the main documentation site.

  • nrepl 0.2.x, Contrib migration, and compatibility are still featured rather prominently on multiple pages. Given the event is 7 years old now, and all users who cared enough already did migrate, I propose to put it into a single place and keep just for posterity. I've moved it into About subfolder which is most likely a wrong place for, so I'm looking for your suggestions.
  • Removed mentions of Boot. There is not much very useful information regarding Boot in the docs, just mentions of it alongside Leiningen.
  • Removed unrepl from the Alternatives page. Since it is abandonware, I don't think it's worth mentioning as an alternative. But maybe you want to keep it as an example of how things could be different, idk.

@alexander-yakushev alexander-yakushev force-pushed the docs-cleanup branch 2 times, most recently from 471d6f7 to 87e83f1 Compare May 20, 2024 11:28
doc/cljdoc.edn Outdated
@@ -26,6 +26,7 @@
["Additional Resources" {:file "doc/modules/ROOT/pages/additional_resources.adoc"}]
["About" {}
["History" {:file "doc/modules/ROOT/pages/about/history.adoc"}]
["Contrib nREPL" {:file "doc/modules/ROOT/pages/about/contrib_nrepl.adoc"}]
Copy link
Contributor

Choose a reason for hiding this comment

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

Probably it'd be better to just add this to the existing History page.

Copy link
Contributor

Choose a reason for hiding this comment

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

Or rather the FAQ, given that all the info here is about upgrading from 0.2.x. In general we can probably remove all of this and nobody would notice this. You said it yourself - 7 years are a lot of time and I doubt anyone it still using nREPL 0.2 at this point.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

@bbatsov bbatsov merged commit f4f7b18 into nrepl:master May 21, 2024
19 checks passed
@alexander-yakushev alexander-yakushev deleted the docs-cleanup branch May 21, 2024 06:20
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.

None yet

2 participants