Update Formatting & Descriptions (#334)

ensdomains · Oct 20, 2024 · c0ea394 · c0ea394
1 parent 20d9e59
commit c0ea394
Show file tree

Hide file tree

Showing 44 changed files with 66 additions and 67 deletions.
diff --git a/app/next-env.d.ts b/app/next-env.d.ts
@@ -2,4 +2,4 @@
 /// <reference types="next/image-types/global" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/basic-features/typescript for more information.
+// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.
diff --git a/app/src/layout/header/search/ResponsiveSearch.tsx b/app/src/layout/header/search/ResponsiveSearch.tsx
@@ -227,8 +227,8 @@ export const ResponsiveSearch = () => {
                             setSelect(-2);
                         }}
                     />
-                    <div className="absolute inset-y-0 left-3 flex h-full items-center text-neutral-300">
-                        <MagnifyingGlassSVG />
+                    <div className="absolute inset-y-0 left-4 flex h-full items-center text-neutral-300">
+                        <MagnifyingGlassSVG className="size-4" />
                     </div>
                     <div className="absolute inset-y-0 right-3 flex h-full items-center text-neutral-300">
                         {isLoading && <FiLoader />}

diff --git a/app/src/layout/header/search/Search.tsx b/app/src/layout/header/search/Search.tsx
@@ -8,7 +8,13 @@ import { SearchModal } from './SearchModal';
 
 function SearchIcon(properties) {
     return (
-        <svg viewBox="0 0 20 20" fill="none" aria-hidden="true" {...properties}>
+        <svg
+            viewBox="0 0 20 20"
+            fill="none"
+            aria-hidden="true"
+            className={clsx('size-5', properties.className)}
+            {...properties}
+        >
             <path
                 strokeLinecap="round"
                 strokeLinejoin="round"
@@ -59,7 +65,7 @@ export function Search() {
             <button
                 type="button"
                 className={clsx(
-                    'outline-ens-500 h-8 w-full items-center gap-2 rounded-lg bg-white pl-2 text-sm text-zinc-500 ring-1 ring-zinc-900/10 hover:ring-zinc-900/20 dark:bg-white/5 dark:text-zinc-400 dark:ring-inset dark:ring-white/10 dark:hover:ring-white/20 lg:flex',
+                    'outline-ens-500 h-8 w-full items-center gap-2 rounded-lg bg-white pl-2 text-sm text-zinc-500 ring-1 ring-zinc-900/10 hover:ring-zinc-900/20 lg:flex dark:bg-white/5 dark:text-zinc-400 dark:ring-inset dark:ring-white/10 dark:hover:ring-white/20',
                     isOpen ? 'opacity-0' : 'opacity-100'
                 )}
                 onClick={() => setOpen(true)}
@@ -68,7 +74,7 @@ export function Search() {
                 Search Content...
                 <span className="ml-auto inline-flex p-1">
                     {modifierKey && (
-                        <kbd className="my-1 flex h-full items-center rounded-md border border-ens-light-border px-1 text-2xs dark:border-ens-dark-border">
+                        <kbd className="border-ens-light-border text-2xs dark:border-ens-dark-border my-1 flex h-full items-center rounded-md border px-1">
                             <kbd className="font-sans">{modifierKey}</kbd>+
                             <kbd className="font-sans">k</kbd>
                         </kbd>
@@ -87,7 +93,7 @@ export function MobileSearch() {
         <div className="contents lg:hidden">
             <button
                 type="button"
-                className="flex size-6 items-center justify-center rounded-md transition-all hover:bg-zinc-900/5 dark:hover:bg-white/5 lg:hidden"
+                className="flex size-6 items-center justify-center rounded-md transition-all hover:bg-zinc-900/5 lg:hidden dark:hover:bg-white/5"
                 aria-label="Search Content..."
                 onClick={() => setOpen(true)}
             >

diff --git a/app/src/layout/header/search/SearchResults.tsx b/app/src/layout/header/search/SearchResults.tsx
@@ -54,7 +54,7 @@ const SearchResultEntry: FC<{
                             // hit._formatted.content ??
                             // hit._formatted.description,
                         }}
-                        className={clsx('block h-[2em] w-full truncate pl-8')}
+                        className={clsx('block h-[2em] w-full truncate')}
                     />
                 </span>
                 <span className="flex gap-2">

diff --git a/docs/contracts/index.mdx b/docs/contracts/index.mdx
@@ -3,7 +3,7 @@ import { WIP } from '@/components/wip/WIP';
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
     description: 'The Ethereum Name Service Smart Contracts Overview',
- emoji: '🗒️',
+    emoji: '🗒️',
     contributors: []
 };
 
@@ -38,7 +38,7 @@ There are various resolvers to choose from, such as the [Public Resolver](/resol
 
 ## Registry & Registrars
 
-The smart contracts can be found on github at [ensdomains/ens-contracts]().
+The smart contracts can be found on github at [ensdomains/ens-contracts](https://github.com/ensdomains/ens-contracts).
 
 <div>
     <div className="grid grid-cols-3 gap-4 not-prose">

diff --git a/docs/dao/constitution.mdx b/docs/dao/constitution.mdx
@@ -16,7 +16,7 @@ Each article has examples of permissible and non permissible actions. These exam
 
 ## I. Name ownership shall not be infringed
 
-ENS governance will not enact any change that infringes on the rights of ENS users to retain names they own, or unfairly discriminate against name owners’ ability to extend, transfer, or otherwise use their names.
+ENS governance will not enact any change that infringes on the rights of ENS users to retain names they own, or unfairly discriminate against name owners' ability to extend, transfer, or otherwise use their names.
 
 ### **Examples**
 
@@ -48,7 +48,7 @@ ENS governance will not allocate funds to a team or individual who does not comm
 
 ## IV. ENS Integrates with the global namespace
 
-In order to facilitate making the most widely usable naming system, ENS aims to integrate with the legacy DNS naming system to the greatest extent possible without sacrificing decentralization of ENS. ENS governance will not enact changes that compromise ENS’s ability to do this.
+In order to facilitate making the most widely usable naming system, ENS aims to integrate with the legacy DNS naming system to the greatest extent possible without sacrificing decentralization of ENS. ENS governance will not enact changes that compromise ENS's ability to do this.
 
 ### **Examples**
 

diff --git a/docs/dao/proposals/1.3.1.mdx b/docs/dao/proposals/1.3.1.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Budget request for Meta-Governance Working Group',
     emoji: '📗',
     contributors: [
         'arachnid'

diff --git a/docs/dao/proposals/1.3.2.mdx b/docs/dao/proposals/1.3.2.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Budget request for ENS Ecosystem Working Group',
     emoji: '📗',
     contributors: [
         'aslobodnik'
@@ -54,4 +54,4 @@ Provide compensation for the stewarding and the coordination efforts of active e
 
 \*Supplement compensation is allocated to the steward who supports coordination or who has greater involvement in DAO activities above what is expected of a steward. The steward council determines how the supplemental compensation is split between the stewards based on contributions of each steward.
 
-It should be noted that the ecosystem working group has three elected stewards (@slobo.eth, @Ginge.eth, @bobjiang) and two appointed stewards (@nick.eth, @jefflau.eth). The appointed stewards are not compensated via this request.
+It should be noted that the ecosystem working group has three elected stewards (@slobo.eth, @Ginge.eth, @bobjiang) and two appointed stewards (@nick.eth, @jefflau.eth). The appointed stewards are not compensated via this request.
diff --git a/docs/dao/proposals/1.3.3.mdx b/docs/dao/proposals/1.3.3.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Budget request for Community Working Group',
     emoji: '📗',
     contributors: [
         'coltron-code'

diff --git a/docs/dao/proposals/1.3.4.mdx b/docs/dao/proposals/1.3.4.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Budget request for Public Goods Working Group',
     emoji: '📗',
     contributors: [
         'alexvandesande'

diff --git a/docs/dao/proposals/2.2.1.mdx b/docs/dao/proposals/2.2.1.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Budget request for Meta-Governance Working Group',
     emoji: '📙',
     contributors: [
         'coltron-code'

diff --git a/docs/dao/proposals/2.2.2.mdx b/docs/dao/proposals/2.2.2.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Budget request for Ecosystem Working Group',
     emoji: '📙',
     contributors: [
         'aslobodnik'

diff --git a/docs/dao/proposals/2.2.3.mdx b/docs/dao/proposals/2.2.3.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Budget request for Public Goods Working Group',
     emoji: '📙',
     contributors: [
         'theanthonyware'

diff --git a/docs/dao/proposals/2.2.5.mdx b/docs/dao/proposals/2.2.5.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Selection of an ENS endowment fund manager',
     emoji: '📙',
     contributors: [
         'arachnid'

diff --git a/docs/dao/proposals/3.4.mdx b/docs/dao/proposals/3.4.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'The first tranche of the Endowment',
     emoji: '📖',
     contributors: [
         'karpatkey'

diff --git a/docs/dao/proposals/3.5.mdx b/docs/dao/proposals/3.5.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'This proposal will activate the new .eth controller and reverse registrar',
     emoji: '📖',
     contributors: [
         // Jeff Lau

diff --git a/docs/dao/proposals/3.6.mdx b/docs/dao/proposals/3.6.mdx
@@ -1,10 +1,9 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Elect a new ENS Foundation director',
     emoji: '📖',
     contributors: [
-        // alisha.eth
-        // 'alisha.eth',
+        'gov.alisha.eth'
     ],
     proposal: {
         discourse: '17008',

diff --git a/docs/dao/proposals/3.7.mdx b/docs/dao/proposals/3.7.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'ENS Normalization Standard',
     emoji: '📖',
     contributors: [
         'raffy.eth'

diff --git a/docs/dao/proposals/4.1.mdx b/docs/dao/proposals/4.1.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Additional actions and strategies for the Endowment',
     emoji: '📖',
     contributors: [
         // Karpatkey

diff --git a/docs/dao/proposals/4.2.mdx b/docs/dao/proposals/4.2.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Fund the Endowment (second tranche)',
     emoji: '📖',
     contributors: [
         // Karpatkey

diff --git a/docs/dao/proposals/4.3.mdx b/docs/dao/proposals/4.3.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Refund Invalid .eth Names',
     emoji: '📖',
     contributors: [],
     proposal: {

diff --git a/docs/dao/proposals/submit.mdx b/docs/dao/proposals/submit.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'The process of submitting a proposal',
     emoji: '🧠',
     contributors: [
         'luc.eth'
@@ -23,7 +23,7 @@ There are three main types of governance proposals you can make:
 
 The purpose of the Temperature Check is to determine if there is sufficient will to make changes to the status quo.
 
-To create a Temperature Check, ask a general, non-biased question to the community on [discuss.ens.domains](https://discuss.ens.domains) about a potential change (example: “Should ENS decrease registration costs for 3-letter domains?”). Forum posts should be in the "DAO-wide -> Temperature Check" category.
+To create a Temperature Check, ask a general, non-biased question to the community on [discuss.ens.domains](https://discuss.ens.domains) about a potential change (example: "Should ENS decrease registration costs for 3-letter domains?"). Forum posts should be in the "DAO-wide -> Temperature Check" category.
 
 Temperature checks are informal and optional; it's up to you to use the feedback to decide if you want to proceed further with your proposal.
 

diff --git a/docs/dao/proposals/voting.mdx b/docs/dao/proposals/voting.mdx
diff --git a/docs/dao/stewards.mdx b/docs/dao/stewards.mdx
@@ -3,7 +3,7 @@ export const meta = {
     description: 'Overview of the current governance stewards',
     emoji: '',
     contributors: [
-        // 'avsa'
+        'avsa.eth'
     ]
 };
 

diff --git a/docs/dao/token.mdx b/docs/dao/token.mdx
@@ -5,7 +5,7 @@ export const meta = {
     contributors: []
 };
 
-# 🪂 Airdrop {{ title: "Airdrop" }}
+# The ENS Token {{ title: "The ENS Token" }}
 
 <Note>ENS Airdropped tokens to anyone who held an ENS name on _October 31st, 2021_. **THERE ARE NO PLANS FOR ANOTHER AIRDROP**. Please be weary of any notices of airdrops as these could turn out fraudulent.</Note>
 

diff --git a/docs/dao/wg/rules.mdx b/docs/dao/wg/rules.mdx
@@ -2,9 +2,7 @@
 export const meta = {
     description: 'Current state of the Working Group Rules as created by EP0.4',
     emoji: '',
-    contributors: [
-        'luc.eth'
-    ]
+    contributors: []
 };
 
 # Working Group Rules

diff --git a/docs/ensip/index.mdx b/docs/ensip/index.mdx
@@ -2,7 +2,7 @@ import { WIP } from '@/components/wip/WIP';
 
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'ENSIPs are improvement proposals to the ENS protocol.',
     emoji: '🧑‍🏫',
     contributors: [
         'luc.eth'

diff --git a/docs/learn/dns.mdx b/docs/learn/dns.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'ENS supports DNS names, allowing users to import DNS names into ENS.',
     emoji: '🌐',
     contributors: [
         'luc.eth'

diff --git a/docs/learn/resolution.mdx b/docs/learn/resolution.mdx
@@ -1,6 +1,6 @@
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'The ENS Resolution Process',
     emoji: '🔍',
     contributors: [
         'luc.eth'

diff --git a/docs/resolution/names.mdx b/docs/resolution/names.mdx
@@ -2,7 +2,7 @@ import { WIP } from '@/components/wip/WIP';
 
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Normalization and recommendations for how to handle names',
     emoji: '⚙️',
     contributors: [
         'luc.eth',

diff --git a/docs/resolvers/interacting.mdx b/docs/resolvers/interacting.mdx
@@ -2,9 +2,11 @@ import { WIP } from "@/components/wip/WIP";
 
 {/* * @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'Set Addresses, Text Records, and more',
     emoji: '👉',
-    contributors: []
+    contributors: [
+      'luc.eth'
+    ]
 };
 
 # Interacting with a Resolver

diff --git a/docs/resolvers/interfaces.mdx b/docs/resolvers/interfaces.mdx
@@ -5,7 +5,7 @@ import { h2, h3, h4 } from '@/components/mdx/heading/h2';
 
 {/* * @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'All interfaces that a resolver may implement.',
     emoji: '👉',
     contributors: [
         'luc.eth',

diff --git a/docs/resolvers/public.mdx b/docs/resolvers/public.mdx
@@ -2,7 +2,7 @@ import { WIP } from "@/components/wip/WIP";
 
 {/* * @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-description: '',
+description: 'A general purpose resolver that suits most user needs.',
 emoji: '🏛️',
 contributors: [
     'luc.eth'

diff --git a/docs/resolvers/quickstart.mdx b/docs/resolvers/quickstart.mdx
@@ -1,10 +1,10 @@
 {/* * @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'A quickstart guide to everything about resolvers.',
     showDetailsSection: false,
 };
 
-# Quickstart Resolver
+# Resolvers Quickstart
 
 At the heart of every ENS name is its resolver. A resolver is a smart contract that implements a specific set of Resolver features (see [Resolver Interface](/resolver/interfaces)).
 The resolvers smart contract functions have control over the resolution process of a "node" (a name or subdomain) and onwards (subdomains of itself).

diff --git a/docs/resolvers/universal.mdx b/docs/resolvers/universal.mdx
@@ -5,7 +5,7 @@ import { h2, h3, h4 } from '@/components/mdx/heading/h2';
 
 {/* * @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'A swiss army knife for resolution.',
     emoji: '👉',
     contributors: [
         'luc.eth',

diff --git a/docs/resolvers/writing.mdx b/docs/resolvers/writing.mdx
@@ -2,7 +2,7 @@ import { WIP } from '@/components/wip/WIP';
 
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'How to write your own resolver.',
     emoji: '✍️',
     contributors: []
 };

diff --git a/docs/web/libraries.mdx b/docs/web/libraries.mdx
@@ -3,7 +3,7 @@ import { ConnectKits } from '@/components/ConnectKits';
 
 {/** @type {import('@/lib/mdxPageProps').MdxMetaProps} */}
 export const meta = {
-    description: '',
+    description: 'A list of libraries and tools to help you interface with the ENS protocol.',
     emoji: '🛠️',
     contributors: [
         'luc.eth',