Skip to content

Migrate site to Docusaurus v3 with full docs, blog and i18n - #3

Merged
ngosang merged 1 commit into
amule-org:mainfrom
ngosang:develop
May 20, 2026
Merged

Migrate site to Docusaurus v3 with full docs, blog and i18n#3
ngosang merged 1 commit into
amule-org:mainfrom
ngosang:develop

Conversation

@ngosang

@ngosang ngosang commented May 20, 2026

Copy link
Copy Markdown
Member

Replace the previous static HTML/CSS/JS landing page with a complete Docusaurus v3 site.

  • Remove static site files: index.html, style.css, lightbox.js, assets/
  • Set up Docusaurus v3 with TypeScript: docusaurus.config.ts, package.json, tsconfig.json, babel.config.js, sidebars.ts, package-lock.json
  • Add homepage React components: FeaturesSection, HighlightsSection, ScreenshotsSection (with scoped CSS modules)
  • Add download page (src/pages/download.tsx)
  • Add global CSS custom properties (src/css/custom.css)
  • Add complete documentation structure under docs/:
    • Quickstart guide
    • User guide: components (aMule, amuled, amulegui, amulecmd, amuleweb), files, configuration, installation, usage
    • ed2k network: concepts, clients, Kademlia
    • Contributing: documentation, translations
    • Development: compilation
    • FAQ, Troubleshooting, Changelogs
  • Add blog post for aMule 3.0.0 release (blog/2026-05-19-amule-3-0-0.md)
  • Add Spanish (es) i18n: UI strings (code.json), all docs, navbar, footer and blog plugin configuration
  • Move screenshots and logo to static/img/, add favicons and docs images
  • Add GitHub Actions workflow for GitHub Pages deployment (.github/workflows/deploy.yml)
  • Add .gitignore, .nojekyll, AGENTS.md, CLAUDE.md
  • Update README.md

@ngosang
Migrate site to Docusaurus v3 with full docs, blog and i18n
cd3385f 
Replace the previous static HTML/CSS/JS landing page with a complete
Docusaurus v3 site.

- Remove static site files: index.html, style.css, lightbox.js, assets/
- Set up Docusaurus v3 with TypeScript: docusaurus.config.ts, package.json,
  tsconfig.json, babel.config.js, sidebars.ts, package-lock.json
- Add homepage React components: FeaturesSection, HighlightsSection,
  ScreenshotsSection (with scoped CSS modules)
- Add download page (src/pages/download.tsx)
- Add global CSS custom properties (src/css/custom.css)
- Add complete documentation structure under docs/:
  - Quickstart guide
  - User guide: components (aMule, amuled, amulegui, amulecmd, amuleweb),
    files, configuration, installation, usage
  - ed2k network: concepts, clients, Kademlia
  - Contributing: documentation, translations
  - Development: compilation
  - FAQ, Troubleshooting, Changelogs
- Add blog post for aMule 3.0.0 release (blog/2026-05-19-amule-3-0-0.md)
- Add Spanish (es) i18n: UI strings (code.json), all docs, navbar, footer
  and blog plugin configuration
- Move screenshots and logo to static/img/, add favicons and docs images
- Add GitHub Actions workflow for GitHub Pages deployment (.github/workflows/deploy.yml)
- Add .gitignore, .nojekyll, AGENTS.md, CLAUDE.md
- Update README.md
@got3nks

got3nks commented May 20, 2026

Copy link
Copy Markdown
Contributor

Do we really need AGENTS.MD and CLAUDE.md in the public repo? 😅

@ngosang ngosang mentioned this pull request May 20, 2026
Closed
@ngosang

ngosang commented May 20, 2026

Copy link
Copy Markdown
Member Author

Do we really need AGENTS.MD and CLAUDE.md in the public repo? 😅

IMHO it's a good idea to commit AGENTS.md (CLAUDE.md is just a symbolic link). This file must be short and include basic architecture of the project and coding guidelines. These rules are global and apply to all collaborators so the LLM agent maintains consistency across PRs from different persons. If you want to add specific SKILLs, MCPs, etc... you can do it in the .claude folder, that is personal and never commited to the repository.
Agent-based programming is relatively new, and there isn't a consensus yet, but most of the people I work with think it's a good idea to include it. Just as we have a README for human developers, we have this file for machines. I think we should also include it in the main aMule repository. But that's just my opinion; I can delete it if we don't agree.

https://www.reddit.com/r/GithubCopilot/comments/1rsu61w/commit_agent_files_to_repo_yay_or_nay/

@ngosang
ngosang merged commit 3fb24ac into amule-org:main May 20, 2026
@ngosang ngosang mentioned this pull request May 20, 2026
Closed
13 tasks
@ngosang

ngosang commented May 20, 2026

Copy link
Copy Markdown
Member Author

@got3nks is the site working now? The first build failed as usual.

@got3nks

got3nks commented May 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

@got3nks is the site working now? The first build failed as usual.

Yes I deleted my comment because now it looks OK. Thanks for your work 👌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ngosang @got3nks