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

Migrate to Vocs #405

Draft
wants to merge 81 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
81 commits
Select commit Hold shift + click to select a range
dcf8423
Init vocs
gskril Jan 13, 2025
c0633f3
Colors, home page
gskril Jan 15, 2025
961cc81
Progress
gskril Jan 16, 2025
6e11556
Install wagmi, create a bunch of building blocks
gskril Jan 16, 2025
d522a69
Sidebar with empty links
gskril Jan 17, 2025
7cf42fa
Config
gskril Jan 17, 2025
7a12efd
Add /web page, fix components
gskril Jan 18, 2025
0df68e1
Add /web/libraries
gskril Jan 18, 2025
b825d95
Add most of the governance pages
gskril Jan 18, 2025
5acff65
Add /dao/stewards page
gskril Jan 18, 2025
76e37b6
Prettier
gskril Jan 18, 2025
4f86356
Generate ENSIP pages
gskril Jan 19, 2025
0b7a9d9
Update .gitignore
gskril Jan 19, 2025
9f727d6
Improve generated sidebar workflow
gskril Jan 19, 2025
1b52de7
Add metadata to ENSIP pages
gskril Jan 19, 2025
cb06af8
Clean up components
gskril Feb 4, 2025
1522579
Add /web/resolution page
gskril Feb 4, 2025
5509064
Add web/records page
gskril Feb 4, 2025
982beb6
Add /web/avatars page
gskril Feb 4, 2025
4c8ec1e
Add /web/reverse page
gskril Feb 5, 2025
0fffb49
Add /web/enumerate page
gskril Feb 5, 2025
9744abb
Add /dweb/intro page
gskril Feb 5, 2025
4d875b0
Add /web/subdomains page
gskril Feb 5, 2025
943b2ee
Finish "Using ENS" section
gskril Feb 5, 2025
9ddba32
Add a bunch of pages from Intro section
gskril Feb 5, 2025
0c51d2a
Generate deployments page, finish Intro section
gskril Feb 6, 2025
baad436
Start contracts section
gskril Feb 7, 2025
668edc4
Add 2 new pages in resolution section
gskril Feb 7, 2025
b6be11f
Add a bunch of contracts pages
gskril Feb 7, 2025
8a85e2f
Add most Registry and NameWrapper pages
gskril Feb 8, 2025
9f3599c
Update naming-contracts.mdx
gskril Feb 19, 2025
a752d3a
Add resolver interfaces
gskril Feb 19, 2025
f557524
Add TLDs page
gskril Feb 19, 2025
877e0e4
Sync proposals from main
gskril Feb 19, 2025
d83c18c
Set frontmatter in all DAO proposals
gskril Feb 20, 2025
8a7c8e1
Convert remaining pages
gskril Feb 20, 2025
78ccdec
Fix links
gskril Feb 21, 2025
9fd92ff
Bump vocs and vite (broken)
gskril Mar 7, 2025
3c5b995
Bump Tailwind, add Node version
gskril Mar 8, 2025
c997d57
Update location of generated deployments file
gskril Mar 8, 2025
a9c2ed0
Generate sidebar items for DAO proposals
gskril Mar 8, 2025
356af97
Fix build
gskril Mar 8, 2025
f8cb1e3
Fix links to static markdown files
gskril Mar 8, 2025
9ea0649
Fix build
gskril Mar 8, 2025
0fe6c60
Minor react fixes
gskril Mar 9, 2025
b9a8a42
Fix relative links in ENSIPs
gskril Mar 10, 2025
b6e8329
Fix sorting of DAO proposals in sidebar
gskril Mar 10, 2025
345d8a4
Move generated json files to a single directory
gskril Mar 10, 2025
6121b8a
Misc typos
gskril Mar 10, 2025
bf3c1e6
Delete Next.js app
gskril Mar 11, 2025
b043b8f
Delete redundant GitHub workflows
gskril Mar 11, 2025
9935af8
Update package.json
gskril Mar 11, 2025
287e909
Merge branch 'master' into vocs
gskril Mar 11, 2025
6593858
Create .nvmrc
gskril Mar 11, 2025
f98bffc
Update `baseUrl`
gskril Mar 11, 2025
ba83870
Hardcode docs.ens.domains for prod deployment
gskril Mar 11, 2025
006b0b6
Fix space-between selector with tailwind v4
gskril Mar 11, 2025
6f25f58
Temporary log search index
gskril Mar 11, 2025
941a473
Revert "Temporary log search index"
gskril Mar 11, 2025
479d14b
Misc code cleanup
gskril Mar 11, 2025
7909245
Generate table of ENSIPs with status
gskril Mar 11, 2025
6baa84e
Fix import
gskril Mar 11, 2025
3c5223d
Fix dark mode (first pass, can customize further)
gskril Mar 13, 2025
4b55b1a
Update edit link
gskril Mar 13, 2025
ef4019a
Add authors to DAO proposals
gskril Mar 13, 2025
f710eee
Merge branch 'master' into vocs
gskril Mar 13, 2025
02fce24
Fix tailwind `dark:` modifiers
gskril Mar 13, 2025
96c71a1
Add dynamic opengraph image via Cloudflare Pages Functions (#407)
gskril Mar 13, 2025
fb9eb86
Initial search patch
gskril Mar 14, 2025
e6bc148
Add search cache back
gskril Mar 14, 2025
4c80348
Update pnpm-lock.yaml
gskril Mar 14, 2025
577cf13
Update readme
gskril Mar 14, 2025
7c4faba
Add error handling to ENSIP page generation
gskril Mar 14, 2025
13f31ef
Don't rebuilt ENSIPs locally
gskril Mar 14, 2025
5b16085
Support mermaid diagrams in ENSIPs
gskril Mar 14, 2025
5c64c47
Fix mermaid rendering
gskril Mar 14, 2025
1fca357
Update landing page design
gskril Mar 14, 2025
0fda6f8
Bump vocs to fix search
gskril Mar 17, 2025
a744095
Revert "Bump vocs to fix search"
gskril Mar 17, 2025
e1aef74
Use remark plugin for mermaid diagram support
gskril Mar 17, 2025
cc70fc5
Bump Vocs
gskril Mar 20, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 0 additions & 4 deletions .github/CODEOWNERS

This file was deleted.

1 change: 0 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE/code_update.md

This file was deleted.

1 change: 0 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE/documentation_update.md

This file was deleted.

1 change: 0 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE/ensip_proposal.md

This file was deleted.

24 changes: 0 additions & 24 deletions .github/actions/install/action.yml

This file was deleted.

25 changes: 0 additions & 25 deletions .github/development.md

This file was deleted.

Binary file removed .github/readme.png
Binary file not shown.
65 changes: 0 additions & 65 deletions .github/workflows/ci.yml

This file was deleted.

59 changes: 0 additions & 59 deletions .github/workflows/deploy.yml

This file was deleted.

17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
.env
.env*.local
*.DS_Store
node_modules
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*
vocs.config.ts.timestamp-*
src/dist

# Generated plugin files
src/pages/deployments.md
src/pages/ensip/*
!src/pages/ensip/index.mdx
src/data/generated/*
!src/data/generated/.keep

1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v22
15 changes: 15 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"semi": false,
"tabWidth": 2,
"printWidth": 80,
"useTabs": false,
"singleQuote": true,
"trailingComma": "es5",
"plugins": [
"@trivago/prettier-plugin-sort-imports",
"prettier-plugin-tailwindcss"
],
"importOrder": ["<THIRD_PARTY_MODULES>", "^@/", "^[./]"],
"importOrderSeparation": true,
"importOrderSortSpecifiers": true
}
21 changes: 11 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,27 @@ This guide will walk you through the process of contributing to the ENS docs. If

#### Create a new issue

If you spot a problem with the docs, [search if an issue already exists](https://github.com/ensdomains/docs/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/ensdomains/docs/issues/new).
If you spot a problem with the docs, [search if an issue already exists](https://github.com/ensdomains/docs/issues). If a related issue doesn't exist, you can [open a new issue](https://github.com/ensdomains/docs/issues/new).

#### Solve an issue

Scan through our [existing issues](https://github.com/ensdomains/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. As a general rule, we don't assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
Scan through our [existing issues](https://github.com/ensdomains/docs/issues) to find one that interests you. As a general rule, we don't assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

### Make Changes

#### Make changes in the UI

Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.mdx` file where you can make your changes and [create a pull request](#pull-request) for a review.

#### Make changes locally

1. Fork the repository.
> [!NOTE]
> Node.js version 20 or higher is required to build the docs.

2. (Optional) If you are making any code changes. Install or update to **Node.js**, or run `nvm use` if using [Node Version Manager](https://nvm.sh). For more information, see [the development guide](.github/development.md).

3. Create a working branch and start with your changes!
1. Fork the repository via the GitHub UI.
2. Clone your forked repository to your local machine.
3. Create a working branch and make your changes!
4. Build the docs locally with `pnpm run build` to ensure your changes are valid.

### Commit your update

Expand All @@ -39,10 +41,9 @@ Commit the changes once you are happy with them. Upon creating a Pull Request yo
### Pull Request

When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.

- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[![readme](./.github/readme.png)](https://docs.ens.domains/?ref=github-banner)
# ENS Documentation

The Ethereum Name Service (ENS) is a distributed, open, and extensible naming system based on the Ethereum blockchain, but available to the entire internet.
This repository contains the source code for [docs.ens.domains](https://docs.ens.domains/?ref=ens-docs-github), as well as the markdown files that make up its contents. It's built with [Vocs](https://vocs.dev/) and deployed to [Cloudflare Pages](https://pages.cloudflare.com/).

## 🗒️ Documentation
Some content is generated at build time from external sources, such as [ENSIPs](https://github.com/ensdomains/ensips) and [smart contract deployments](https://github.com/ensdomains/ens-contracts). Markdown generation is handled by Vite plugins located in the `src/plugins` directory.

The ENS documentation is available at [docs.ens.domains](https://docs.ens.domains/?ref=ens-docs-github). This repository contains the source code for the documentation, as well as the markdown files that make up its contents.
Cloudflare [Pages Functions](https://developers.cloudflare.com/pages/functions/) are used to dynamically generate opengraph images for each page.

## 📖 Contributing

We welcome contributions to the ENS documentation. If you would like to contribute, please read the [contributing guidelines](./CONTRIBUTING.md). All content is written in mdx, and [markdown files can be found here](./docs).
We welcome contributions to the ENS documentation. If you would like to contribute, please read the [contributing guidelines](./CONTRIBUTING.md). All content is written in mdx, and [markdown files can be found here](./src/pages/).

## 📄 License

Expand Down
23 changes: 0 additions & 23 deletions app/.eslintrc.json

This file was deleted.

12 changes: 0 additions & 12 deletions app/.gitignore

This file was deleted.

1 change: 0 additions & 1 deletion app/.nvmrc

This file was deleted.

6 changes: 0 additions & 6 deletions app/.prettierrc

This file was deleted.

Loading