Skip to content

docs: Update Tectonic README#2

Open
ankitkr104 wants to merge 2 commits into
StabilityNexus:mainfrom
ankitkr104:feat/hero-image-corner-fix
Open

docs: Update Tectonic README#2
ankitkr104 wants to merge 2 commits into
StabilityNexus:mainfrom
ankitkr104:feat/hero-image-corner-fix

Conversation

@ankitkr104
Copy link
Copy Markdown
Contributor

@ankitkr104 ankitkr104 commented May 27, 2026

Summary

Updated the README to match the actual Tectonic EVM Web UI project instead of the placeholder template.

What changed

  • Replaced placeholder branding with Tectonic-specific title, badge, and hero image
  • Added a proper project overview describing the Next.js frontend
  • Documented the actual stack: Next.js 16, React 19, TypeScript, Tailwind CSS 4, ESLint
  • Added a clear project structure section for app/, public/, and config files
  • Updated setup instructions to match the real scripts in package.json
  • Cleaned up the contribution section to reflect the repo’s current workflow

Validation

  • npm run build

AI Usage Disclosure:

We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact. AI slop is strongly discouraged and may lead to banning and blocking. Do not spam our repos with AI slop.

Check one of the checkboxes below:

  • This PR does not contain AI-generated code at all.
  • This PR contains AI-generated code. I have read the AI Usage Policy and this PR complies with this policy. I have tested the code locally and I am responsible for it.

I have used the following AI models and tools: TODO

Checklist

  • My PR addresses a single issue, fixes a single bug or makes a single improvement.
  • My code follows the project's code style and conventions
  • If applicable, I have made corresponding changes or additions to the documentation
  • If applicable, I have made corresponding changes or additions to tests
  • My changes generate no new warnings or errors
  • I have joined the Discord server and I will share a link to this PR with the project maintainers there
  • I have read the Contribution Guidelines
  • Once I submit my PR, CodeRabbit AI will automatically review it and I will address CodeRabbit's comments.
  • I have filled this PR template completely and carefully, and I understand that my PR may be closed without review otherwise.

Summary by CodeRabbit

  • Documentation
    • Updated project branding and landing content to “Tectonic EVM Web UI”
    • Rewrote project maturity/status checklist specific to the Web UI
    • Refreshed tech stack and project structure to Next.js 16 / React 19 / TypeScript / Tailwind CSS 4
    • Revised Getting Started and build/run instructions (Node.js 20+ prerequisites)
    • Added/updated social links and updated copyright year to 2026

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 27, 2026

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: ASSERTIVE

Plan: Free

Run ID: f94d3dbd-783b-4249-8201-c60d61d1405a

📥 Commits

Reviewing files that changed from the base of the PR and between 101e9c4 and 9bba6a9.

📒 Files selected for processing (1)
  • README.md

Walkthrough

The README is rewritten from a placeholder into a Tectonic EVM Web UI landing page: updated branding and social badges, a project-specific description, a maturity checklist, concrete tech stack and project structure, revised getting-started commands (Node.js 20+), and updated contributing steps and copyright year.

Changes

README Documentation Refresh

Layer / File(s) Summary
Project branding and social presence
README.md
Hero/logo area updated and "Tectonic-EVM_Web_UI" badge replaces the prior TODO; social badges for Medium, LinkedIn, and YouTube added; main header and short description now identify the project as "Tectonic EVM Web UI".
Project status and technical documentation
README.md
Project maturity checklist replaced with a Tectonic/Web UI-focused list; Tech Stack, Assets, Project Structure, and Project Config sections updated to reference Next.js 16, React 19, TypeScript, Tailwind CSS 4, app router paths, public assets, and config files.
Developer onboarding and contribution
README.md
Getting Started updated for Node.js 20+ with new clone/install/dev/build/start commands; Contributing now references npm run build and npm run lint; copyright year updated to 2026.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A README once filled with TODOs and blanks,
Now shines with Tectonic's purpose and ranks,
Next.js and React in tidy array,
Instructions clear for a bright dev day.
From badge to footer, the landing's in bloom—✨


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

Comment @coderabbitai help to get the list of available commands and usage tips.

@ankitkr104 ankitkr104 added GSoC 2026 Work completed under GSoC 2026 documentation Improvements or additions to documentation labels May 27, 2026
Comment thread README.md
[![Static Badge](https://img.shields.io/badge/Stability_Nexus-/TODO-228B22?style=for-the-badge&labelColor=FFC517)](https://TODO.stability.nexus/)

<!-- Correct deployed url to be added -->
[![Static Badge](https://img.shields.io/badge/Tectonic-EVM_Web_UI-228B22?style=for-the-badge&labelColor=FFC517)](https://github.com/StabilityNexus/Tectonic-EVM-WebUI)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix the Tectonic logo placement.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tectonic logo placement, is there any official logo already decided for the project, or should I design/update one from my side?

Also, the current logo that I used from the web and shared in my previous PR #1 — is that fine to continue with for now?

Comment thread README.md
</div>

[TODO](https://TODO.stability.nexus/) is a ... TODO: Project Description.
[Tectonic](https://github.com/StabilityNexus/Tectonic-EVM-WebUI) is a Next.js frontend for the Tectonic protocol. It presents the protocol story, feature highlights, community links, and update sections in a polished landing page experience.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tectonic hyperlink should redirect to frontend.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently, the frontend is ready, but it is not live yet because some GitHub Actions/workflow approvals are still needed from the mentor side for deployment. That’s why the hyperlink is not redirecting to the live frontend at the moment.

Comment thread README.md
</div>

[TODO](https://TODO.stability.nexus/) is a ... TODO: Project Description.
[Tectonic](https://github.com/StabilityNexus/Tectonic-EVM-WebUI) is a Next.js frontend for the Tectonic protocol. It presents the protocol story, feature highlights, community links, and update sections in a polished landing page experience.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improe this to tell about Tectonic as a project, what does it offer. If unclear, ask in discord.

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

Labels

documentation Improvements or additions to documentation GSoC 2026 Work completed under GSoC 2026

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants