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

blog post fixes #2412

Merged
merged 4 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 29 additions & 28 deletions blog/2025-01-01.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags: [updates]

*2024 was a great year for NEAR Docs! Let's take a look at what we achieved together*

<p><img src="https://pbs.twimg.com/media/GgXvyR4WIAAmEG-?format=jpg&name=medium" /></p>
<p><img src="/docs/blog/2024-review/2024-blog.jpg" /></p>

<!-- truncate -->

Expand All @@ -17,22 +17,22 @@ There is something that we like to do every new year, and that is to take a look

You see, NEAR is a live ecosystem, where new features are added constantly, products and projects emerge, and our docs need to reflect that. This means that we are always adding, removing, and updating content.

By looking at the changes we made, we get to not only remember what we achieved - it is always nice to see all we built in a year - but it also helps us to discover what we lost in the way!
By looking at the changes we made, we get to remember what we achieved - it is always nice to see all we built in a year - and it also helps us discover what we lost along the way!

Join us while we take a look at the changes we made in 2024, and what we are planning for 2025.

## Consolidating Documentation

One of the main issues that we tackled this year was the consolidation of our documentation.
One of the main issues we tackled this year was consolidating our documentation.

Users often complained that we had a lot of content spread across different section, pages and repositories, and we wanted to bring it all together in one place.
Users often complained that we had a lot of content spread across different sections, pages, and repositories, and we wanted to bring it all together in one place.

At the beginning of 2024, we had different menus for [Concepts](/concepts/basics/protocol), [Smart Contracts](/build/smart-contracts/what-is), [Web Applications](/build/web3-apps/what-is), and [Data Infrastructure](/build/data-infrastructure/what-is).

We decided to merge all these pages into a single `Docs` section, with a shared navigation bar, so you can always easily jump from one topic to another.

![Navigation](https://pbs.twimg.com/media/GgXvyR4WIAAmEG-?format=jpg&name=medium)
_Navigation before (left) and now (right), notice how many links were removed both top and left navigation bars!_
![Navigation](/docs/blog/2024-review/2024-blog.jpg)
_Navigation before (left) and now (right), notice how many links were removed from both top and left navigation bars!_

To keep the sidebar clean, we added a `What is...` page for each major topic, which helps you to understand the basics and decide if that section is what you are looking for.

Expand All @@ -44,66 +44,67 @@ For example, we now have the following pages:

## Code Explainer

During this year we took a couple of weeks to build an in-house tool to simplify explaining code!
During this year, we took a couple of weeks to build an in-house tool to simplify explaining code!

![code explainer](https://pbs.twimg.com/media/GgX0ivUXgAEQJZE?format=jpg&name=medium)
![code explainer](/docs/blog/2024-review/2024-blog-2.jpg)

The new `Code Explainer` allows us to easily explain long snippets of code, by highlighting the important parts and adding text blocks to explain what is happening.
The new `Code Explainer` allows us to easily explain long snippets of code, by highlighting the essential parts and adding text blocks to explain what is happening.

Our new [Smart Contract Anatomy](/build/smart-contracts/anatomy/) section looks amazing and is much easier to understand now!

## 2024: A Year of Growth

We have been busy this year adding new sections, pages and tutorials to our documentation. Let's briefly go through some of them.
This year we have been busy adding new sections, pages, and tutorials to our documentation. Let's briefly go through some of them.

### Primitives

One of the first things we added was a section about [Primitives](/build/primitives/what-is), which explains the basic building blocks of NEAR Protocol.

![Primitives](https://pbs.twimg.com/media/GgX1MWqW0AAE8Tb?format=jpg&name=4096x4096)
![Primitives](/docs/blog/2024-review/2024-blog-3.jpg)

At the new Primitives section, we show how to create and use [NFTs](/build/primitives/nft), [FTs](/build/primitives/ft), [DAOs](/build/primitives/dao), [Linkdrops](/build/primitives/linkdrop), [Oracles](/build/primitives/oracles) and [Decentralized Exchanges](/build/primitives/dex).
In the new Primitives section, we show how to create and use [NFTs](/build/primitives/nft), [FTs](/build/primitives/ft), [DAOs](/build/primitives/dao), [Linkdrops](/build/primitives/linkdrop), [Oracles](/build/primitives/oracles), and [Decentralized Exchanges](/build/primitives/dex).

Every page is full of snippets, that explain how to leverage each primitive from any tool that you are using, be it the bash terminal, a web application or from within a smart contract.
Every page is full of snippets that explain how to leverage each primitive from any tool that you are using, be it the bash terminal, a web application, or from within a smart contract.

### Chain Abstraction

We also added a section about [Chain Abstraction](/build/chain-abstraction/what-is), which explains how NEAR accounts can be used to control accounts on other chains.

![alt text](https://pbs.twimg.com/media/GgX1MWqW0AAE8Tb?format=jpg&name=medium)
![alt text](/docs/blog/2024-review/2024-blog-4.jpg)
_Did you know you can control Ethereum and Bitcoin accounts from NEAR?_

We expect to make this section grow in 2025, as we are planning to add more tutorials and examples on how to interact with chains like Base, Solana and Polygon.
We expect to make this section grow in 2025, as we plan to add more tutorials and examples on interacting with chains like Base, Solana, and Polygon.

### New Beginner's Guide

In 2024 we also released a brand new [Step-by-Step Guide to Mastering Near](/tutorials/auction/introduction). This guide is perfect for beginners, as it explains everything from creating an account, to deploying a smart contract, creating a web application for it, and even how to monitor the contract's activity!
In 2024 we also released a brand new [Step-by-Step Guide to Mastering Near](/tutorials/auction/introduction). This guide is perfect for beginners, as it explains everything from creating an account to deploying a smart contract, creating a web application for it, and even how to monitor the contract's activity!

![Beginner's Guide](https://pbs.twimg.com/media/GgZYC2lX0AEX5E4?format=jpg&name=medium)
![Beginner's Guide](/docs/blog/2024-review/2024-blog-5.jpg)

It is our most complete guide yet! But stay tuned, as we are planning to add more tutorials and examples to it in 2025.

## NEAR API
### NEAR API

We also released a new version of our [API documentation](/tools/near-api), which now includes all API flavors - JavaScript, Rust, and Python.

![API](https://pbs.twimg.com/media/GgZZWGoXoAAru7R?format=jpg&name=medium)
![API](/docs/blog/2024-review/2024-blog-6.jpg)

In this new version, we added a lot of examples on how to use the API in the most common scenarios, as well as linked all the code to a single [github repository](https://github.com/near-examples), to make it easier for us to test it, and for you to copy and paste the code.
In this new version, we added a lot of examples on how to use the API in the most common scenarios, as well as linked all the code to a single [GitHub repository](https://github.com/near-examples), to make it easier for us to test it, and for you to copy and paste the code.

## Near Examples
An important part of our documentation is the examples it references. We have been working hard to make sure that all examples are up to date and working.
### Near Examples

For example, we have updated all our canonical examples (Hello Near, Counter, Donations, NFT, FT) to use the latest version of core libraries (near-api, near-sdk and wallet-selector)
An important part of our documentation is the examples it references. We have been working hard to make sure that all examples are up-to-date and working.

For example, we have updated all our canonical examples (Hello Near, Counter, Donations, NFT, FT) to use the latest version of core libraries (`near-api`, `near-sdk` and `wallet-selector`)

## Looking Forward

We are excited to start 2025 with a lot of new ideas and projects in mind. We are planning to add new examples on how to build complex DeFi applications on NEAR, as well as adding community projects such as [Pikespeak](https://doc.pikespeak.ai/), [FastNear](https://github.com/fastnear/explorer-api) and [NearBlocks](https://api.nearblocks.io/api-docs/)
We are excited to start 2025 with a lot of new ideas and projects in mind. We are planning to add new examples about how to build complex DeFi applications on NEAR, as well as adding community projects such as [Pikespeak](https://doc.pikespeak.ai/), [FastNear](https://github.com/fastnear/explorer-api), and [NearBlocks](https://api.nearblocks.io/api-docs/)

More importantly, we are looking forward for 2025 to be the year of AI, focusing on building docs showing how easy is to use [NEAR AI](https://near.ai) to build and deploy machine learning models on NEAR.
More importantly, we expect 2025 to be the year of AI, focusing on building docs showing how easy is to use [NEAR AI](https://near.ai) to build and deploy machine learning models on NEAR.

By focusing on AI, we also expect to be able to bring new ways to engage with our documentation, such as a chatbot that can help you to find the right page!
By focusing on AI, we also expect to bring new ways to engage with our documentation, such as a chatbot that can help you find the right page!

All of course using open-source tools and libraries, so you can easily replicate what we are doing.
Of course, everything is being developed using open-source tools and libraries, so you can easily replicate what we are doing.

We are excited to start this new year, and hope you are too! 🚀
We are excited to start this new year, and hope you are too! 🚀
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading