Develop

CONTRIBUTING.md

@@ -20,7 +20,7 @@ Create `src/data/terms/{term_id}.ts` (lowercase with underscores only):
 
 ```typescript
 import type { TTerm } from '@/types'
-import { LOCALES } from '@/data/locales'
+import { LOCALES } from '@/common'
 import { SOURCES } from '@/data/sources'
 import { TAGS } from '@/data/tags'
 import { TYPES } from '@/data/types'
@@ -96,7 +96,7 @@ Create `src/data/types/{type_id}.ts` or `src/data/tags/{tag_id}.ts`:
 
 ```typescript
 import type { TType } from '@/types'
-import { LOCALES } from '@/data/locales'
+import { LOCALES } from '@/common'
 
 export default {
   id: 'database',
@@ -141,7 +141,7 @@ label: {
 
 ## Adding a New Language
 
-1. Add locale to `src/data/locales/index.ts`:
+1. Add locale to `src/common/index.ts`:
 ```typescript
 export const LOCALES = {
   EN_US: 'en-US',

README.md

@@ -4,7 +4,7 @@
 
 # dev-dict
 
-A collection of software development terms (with multilingual support). Useful for building developer tools, documentation sites, personal portfolios, etc.
+A multilingual collection of software development terms. Useful for building developer tools, documentation sites, personal portfolios, etc.
 
 **[Docs](https://kyco.github.io/dev-dict/docs)** · **[Browse all terms](https://kyco.github.io/dev-dict/)**
 
@@ -17,11 +17,10 @@ npm install dev-dict
 ## Usage
 
 ```typescript
-import { terms } from 'dev-dict'
-import { getTerms } from 'dev-dict/utils'
+import { TERMS, getTerms } from 'dev-dict'
 
 // Define dictionary
-const dictionary = getTerms({ terms })
+const dictionary = getTerms({ terms: TERMS, locale: 'en-US' })
 
 // Display terms
 dictionary.forEach(term => {
@@ -39,7 +38,7 @@ Dev-dict contains 220+ terms. To keep your bundle small import only the terms yo
 import { react, typescript } from 'dev-dict/terms'
 
 // BAD
-import { terms } from 'dev-dict'
+import { TERMS } from 'dev-dict'
 ```
 
 The root entry is best suited for server-side or build-time use cases where you need the full dataset (e.g. generating a static glossary page).

demo/src/components/TermCard.tsx

@@ -1,9 +1,9 @@
 import { Link } from '@tanstack/react-router'
 import type { TTermLocalized, TTermTagLocalized, TTermTypeLocalized } from 'dev-dict'
-import { Book, Check, Copy } from 'lucide-react'
+import { Check, Copy, Pencil } from 'lucide-react'
 
+import { getGithubEditUrl } from '~/shared/constants'
 import { useCopyToClipboard } from '~/shared/hooks'
-import { getTermCompleteness } from '~/shared/utils/termUtils'
 
 import { Chip } from './Chip'
 import { TermLinks } from './TermLinks'
@@ -16,7 +16,6 @@ interface TermCardProps {
 
 export function TermCard({ term, searchQuery, populateEmpty = true }: TermCardProps) {
   const { copied, copy } = useCopyToClipboard()
-  const completeness = getTermCompleteness(term.id)
 
   const copyId = (e: React.MouseEvent) => {
     e.preventDefault()
@@ -72,10 +71,18 @@ export function TermCard({ term, searchQuery, populateEmpty = true }: TermCardPr
             )}
           </button>
         </div>
-        <div className="flex flex-col items-end gap-1">
-          <Book size={20} className="text-slate-300 group-hover:text-blue-400 transition-colors flex-shrink-0" />
-          <span className="text-xs font-semibold text-slate-400">{completeness.fullPercentage}%</span>
-        </div>
+
+        <a
+          href={getGithubEditUrl(term.id)}
+          target="_blank"
+          rel="noopener noreferrer"
+          onClick={(e) => e.stopPropagation()}
+          className="flex-shrink-0 px-2.5 py-1 text-xs font-medium text-slate-500 bg-slate-100 border border-slate-200 hover:bg-blue-50 hover:text-blue-600 hover:border-blue-200 rounded-lg transition-colors flex items-center gap-1"
+          title="Edit this term on GitHub"
+        >
+          <Pencil size={12} />
+          Edit
+        </a>
       </div>
 
       <p className="text-slate-600 text-sm leading-relaxed mb-4 line-clamp-2">

demo/src/components/index.ts

@@ -1,5 +1,4 @@
 export { Chip } from './Chip'
-export { CompletenessChart } from './CompletenessChart'
 export { Dropdown } from './Dropdown'
 export { LanguageDropdown } from './LanguageDropdown'
 export { SearchBar } from './SearchBar'