Skip to content

DOCS_INDEX.md

Latest commit

 

History

History
121 lines (93 loc) · 4.6 KB

DOCS_INDEX.md

File metadata and controls

121 lines (93 loc) · 4.6 KB

📖 Cvians UI - Documentation Index

Welcome to the complete documentation for Cvians UI Components - a modern React/Preact component library with Excel-like functionality.

🚀 Quick Start

Installation

# Install CLI globally
npm install -g @codvista/cvians-cli

# Install core components
npm install @codvista/cvians-excel-table

Basic Usage

import { ExcelTable } from '@codvista/cvians-excel-table';

const data = [
  { name: 'John', age: 30, city: 'New York' },
  { name: 'Jane', age: 25, city: 'San Francisco' }
];

export default function App() {
  return <ExcelTable data={data} />;
}

📚 Documentation Structure

🏗️ Getting Started

Document Description Link
Main README Project overview, installation, quick start README.md
Setup Guide Complete project setup instructions SETUP_SUMMARY.md
Contributing Guidelines for contributors CONTRIBUTING.md

🧩 Components

Component Description Link
Excel Table Main table component with filtering/sorting Core README
CLI Tool Command-line installation tool CLI README

💡 Examples & Usage

Resource Description Link
Examples Overview All usage examples and demos Examples README
Basic Usage TypeScript examples with different data types basic-usage.tsx

🚀 Development & Publishing

Document Description Link
Publishing Guide How to publish to npm PUBLISHING.md
NPM Setup Detailed npm publishing instructions NPM_PUBLISHING_GUIDE.md
GitHub Integration CI/CD setup and GitHub Actions GITHUB_INTEGRATION.md
Publishing Instructions Step-by-step publishing process PUBLISHING_INSTRUCTIONS.md

🔧 Maintenance & Support

Document Description Link
Troubleshooting Common issues and solutions TROUBLESHOOTING.md
Roadmap Future features and development plans ROADMAP.md
Changelog Version history and changes CHANGELOG.md

🔗 External Links

NPM Packages

GitHub Resources

🎯 Quick Navigation

For Users

  1. Install: npm install @codvista/cvians-excel-table
  2. Learn: Check Examples
  3. Implement: Use Core README
  4. Support: See Troubleshooting

For Contributors

  1. Setup: Follow Setup Guide
  2. Contribute: Read Contributing Guidelines
  3. Publish: Use Publishing Guide
  4. Develop: Check Main README development section

For CLI Users

  1. Install: npm install -g @codvista/cvians-cli
  2. Initialize: cvians init
  3. Add Components: cvians add excel-table
  4. Help: cvians --help

📊 Component Overview

Component Status Features Package
ExcelTable ✅ Released Filtering, Sorting, Type-aware @codvista/cvians-excel-table
CLI Tool ✅ Released Component installation, Project init @codvista/cvians-cli

🏷️ Current Version

  • Core: v0.2.0
  • CLI: v0.2.0
  • Status: 🟢 Stable & Published

💬 Get Help

  1. 📖 Documentation: Start with this index
  2. 💡 Examples: Check examples directory
  3. 🐛 Issues: Report on GitHub
  4. 💬 Discussions: GitHub Discussions

Built with ❤️ by Taha Kazmi