Skip to content

Commit

Permalink
Introduce basic post
Browse files Browse the repository at this point in the history
  • Loading branch information
lucemans committed Feb 20, 2024
1 parent 01acd2d commit 6321bd1
Show file tree
Hide file tree
Showing 7 changed files with 68 additions and 0 deletions.
Binary file added content/017_documentation_update/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/017_documentation_update/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/017_documentation_update/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/017_documentation_update/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/017_documentation_update/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions content/017_documentation_update/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"slug": "documentation-update-1",
"cover": "https://img.youtube.com/vi/GwX_m28SSOA/0.jpg",
"title": "Updating the ENS Documentation",
"description": "The ENS Documentation is receiving an upgrade to its documentation featuring a new look and feel, improved navigation, and a full content rewrite.",
"date": "2024-02-20",
"youtube": "GwX_m28SSOA",
"tags": [""],
"authors": ["luc.eth"]
}
58 changes: 58 additions & 0 deletions content/017_documentation_update/readme.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
After months of hard work, we are proud to announce the release of the new ENS documentation!
When taking on this journey when I first joined the team, I had no idea what I was getting myself into.
But **luc**kily with great minds, some croissants, and a writers retreat later, we have finally made it!

![image](./1.png)

## Thorin Design

With new docs comes a new look and feel!
The Thorin design system, that was introduced in the Manager App with v3 has made its way to the docs!

### Dark Theme

We all love light theme... or well, I do (luc.eth writing this).
But for those of us trying to save our eyes at night, the docs now have a dark theme!
Meaning you can switch between light and dark theme at any time.

![Dark Theme vs Light Theme](./4.png)

## Interactive Components

Building with ENS means standards, specs, and on-chain shenanigans. To help you understand it all, we have built interactive sections that walk you through procedures, such as registering a name, renewing, transferring, and more.

All of this means you can now easily debug your resolver, fix your name records, and learn how ENS resolution works.

![Renew a Name & List Names, Directly from within the Documentation](./2.png)

## Name Wrapper

Since our [release of the Name Wrapper](https://www.youtube.com/watch?v=njb7jp5_Qoo) we have seen an increasing demand in users interested in understanding how it works.
So to satisfy your curiosity, we have created a section dedicated to the Name Wrapper, where you can learn more about how it works,
particular behaviours, and how to use it.

Checkout the Name Wrapper section [here](https://docs.ens.domains/namewrapper).

## TLD List

Furthering our commitment to improve the DNS namespace, we have created a TLD list page, where you can see all the TLDs and the state per TLD regarding DNS support, ENS support, and registry behaviour.
You can find the TLD list page [here](https://docs.ens.domains/dns/tlds).

![Supported TLD List](./3.png)

If you spot a TLD that is not listed, or has incorrect information, please let us know by creating an issue on the [ENS documentation GitHub repository](https://github.com/ensdomains/docs).

## Improved Search

We have improved the search functionality, now with section-based filtering, it is easier then ever to find the content you're after.
Wether its ENSIPs, Governance Proposals, or anything else.

![Improved Search](./5.png)

## What's Next?

We are not done yet! We are already working on a whole list of few more features & edits to make the documentation even better.
There is much more to look forward to, and we welcome any and all contributions to [the documentation](https://github.com/ensdomains/docs).

Does this sound like **the** _challenge for you?_ We are looking for a technical writer to join the team and help us make the documentation even better.
Checkout the job posting [here](https://enslabs.org/).

0 comments on commit 6321bd1

Please sign in to comment.