Skip to content

Commit

Permalink
Create 2024-12-17-introducing-new-docs-landing-page.markdown (#424)
Browse files Browse the repository at this point in the history
* Create 2024-12-17-introducing-new-docs-landing-page.markdown

* Add screenshot of Docs landing page
  • Loading branch information
AmandaPerino authored Dec 17, 2024
1 parent d0d1975 commit a7f318b
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions _posts/2024-12-17-introducing-new-docs-landing-page.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
layout: post
title: "Introducing the new Docs landing page"
categories: news, foundation
author: Amanda Perino
published: true
date: 2024-12-17
---

Last week, we published a bunch of [new](https://rubyonrails.org/2024/12/12/introducing-doximity-case-study) and [updated](https://rubyonrails.org/2024/12/13/learn-Rails-8-tutorial-and-unpacked-videos) resources to help you learn Rails and learn how companies leverage Rails to build successful businesses. But we also made a few structural and navigational changes to the website that you may not have noticed (yet).

**The challenge: lots of resources, little space**

Earlier this year, we had big plans:
- Create a new flagship tutorial (with more planned soon).
- Extract the Rails installation instructions from the tutorial into a standalone Installation Guide (because you shouldn’t have to find this information buried in chapter 3 of a tutorial).
- Publish the first case study (with more planned soon).
- On top of all that, launch a merch store.

We were excited that all this was coming, but the navbar was already quite crowded..._where were all these new resources going to live?_

**The solution: a unified Docs landing page**

Introducing **[Docs](/docs)**, the friendly new starting point for everything you need to install Rails, learn it, get better at it, and get involved.

From one convenient page, you can now access the following: Installation Guide, Tutorials, Guides, API Docs, Case Studies, the Forum, and the Contributing Guide.

<img src="/assets/images/docs-landing-page.png">

Other changes you might notice in the navbar:
- We’ve renamed ‘Contribute’ to **Source** to clarify the difference between the GitHub repository and the Contributing Guide. (We also made the **Contributing Guide** easier to find. Rails is an open-source project, but this important info was buried 85% down the Guides index page. It’s now featured more prominently on the Docs landing page.)
- ‘Team’ is now called **Community**, where you can find all of the Rails teams and the Contributors site. This renaming also balances out the navbar.
- The ‘Blog’ is now called **News** since it also contains Rails Foundation news alongside Rails updates and This Week in Rails newsletters.
- With **Guides**, **API docs**, and the **Forum** now nested under **Docs**, this gave us room in the navbar to add
**Merch** and **Events**.

These changes aim to make the Rails website more welcoming and friendly-to-navigate for beginners, while helping you, as a more experienced Rails dev, find what you need quickly. This (re)structure also gives the Rails Foundation a clear home for future tutorials and case studies, so expect more of those released next year.

[Take a look at the new Docs page](/docs) and let us know what you think!

_The Docs landing page was designed and shipped by <a href="https://www.meticulous.com/">John Athayde</a> with feedback and direction from the **Rails Core**, **Issues**, and **Committers** teams, and made possible by the support of the **members of the Rails Foundation**. Thank you to everyone involved for your input!_
Binary file added assets/images/docs-landing-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a7f318b

Please sign in to comment.