A text-mode web browser with AI help, inspired by Lynx, plus TextFirst.css for text-first websites.

0 downloads

dbbasic-textbrowser/DOCS-INDEX.md
Download zip
Clone
Clone with git
git clone https://gitstable.com/git/askrobots/dbbasic-textbrowser.git
HTTPS
https://gitstable.com/git/askrobots/dbbasic-textbrowser.git
SSH
ssh://git@gitstable.com:2222/askrobots/dbbasic-textbrowser.git

Cloning needs no sign-in. Pushing over HTTPS asks for your username and an access token. SSH needs your key under SSH keys.

danq9 Add Gateway Architecture documentation 2693936 1 year ago History
DOCS-INDEX.md · 9.9 KB · 326 lines

Documentation Index

Complete guide to all documentation in DBBasic TextBrowser


Start Here 🚀

New to the project? Start with these:

  1. README.md - Project overview and features
  2. QUICKSTART.md - Get started in 5 minutes
  3. demo/index.html - Interactive demo of TextFirst.css

Project Status 📊

Current state and metrics:

  • PROJECT-STATUS.md - Complete project overview
  • Executive summary
  • All completed milestones
  • Technical metrics (28 tests, 13 KB CSS)
  • File structure
  • Comparison with modern frameworks
  • Future roadmap
  • SESSION-SUMMARY.md - Original development session
  • What we built
  • Why we built it
  • Test suite details
  • Philosophy discovered
  • CONTINUATION-SUMMARY.md - Continued session
  • Verification and validation
  • Key insights captured
  • Documentation created
  • Final polish

Technical Documentation 🔧

TextFirst.css Framework

  • SEMANTIC-CSS-FRAMEWORK.md - Framework philosophy
  • The Tri-Hard Pattern (and why it's bad)
  • Progressive enhancement
  • Comparison: 1997 vs 2025 Tailwind vs TextFirst.css
  • Why 13 KB beats 3 MB
  • Semantic HTML specification
  • TEXT-WEB-HTML.md - HTML tag reference
  • New semantic tags (<color>, <box>, <banner>, <status>)
  • Enhanced old tags (<font color>, <center>, <menu>)
  • Implementation guide
  • Browser compatibility
  • Usage examples

Testing

  • tests/README.md - Test documentation
  • 11 unit tests
  • 17 integration tests
  • Coverage details
  • How to run tests

Philosophy & History 📚

Why Text-First Matters

  • IT-JUST-WORKS.md - The irony of simplicity
  • Basic HTML/CSS working everywhere is remarkable in 2025
  • Build process comparison
  • "Works on my machine" problem solved
  • The return to sanity
  • IDEAS.md - Original design philosophy
  • Why text browsers matter
  • Bridging BBS ANSI with HTML colors
  • AI integration rationale

Historical Context

  • WEB-DESIGN-HISTORY.md - Web evolution 1995-2025
  • Era 1: Simple HTML (1995-1999)
  • Era 2: Photoshop Slicing Disaster (2000-2005)
  • Era 3: CSS/JS Separation (2006-2010)
  • Era 4: Responsive Design (2011-2015)
  • Era 5: Framework Explosion (2016-2020)
  • Era 6: Build Tool Hell (2021-2024)
  • Era 7: Back to Simple (2025+)
  • MOBILE-WEB-HISTORY.md - Mobile web complexity cycle
  • WAP/WML era (1999-2007)
  • Separate mobile sites (2007-2010)
  • Responsive design (2010-2015)
  • Framework complexity (2015-2025)
  • Back to responsive (2025+)

Case Studies

  • USEIT-PARADOX.md - Jakob Nielsen's site
  • Old site: perfectly usable, < 1 second load
  • New site: slower, less usable, but "prettier"
  • Performance comparison
  • What they lost (differentiation, free marketing)
  • The stakeholder trap
  • Lessons for DBBasic TextBrowser

By Use Case 🎯

I want to...

...understand the project quickly → Start: README.md → Then: QUICKSTART.md

...see it in action → Demo: demo/index.html → Open in browser and text browser to compare

...understand the philosophy → Read: SEMANTIC-CSS-FRAMEWORK.md → Then: IT-JUST-WORKS.md

...learn from history → Read: WEB-DESIGN-HISTORY.md → Then: USEIT-PARADOX.md

...use TextFirst.css → Start: QUICKSTART.md → Reference: TEXT-WEB-HTML.md → Demo: demo/index.html

...contribute → Tests: tests/README.md → Status: PROJECT-STATUS.md → Philosophy: SEMANTIC-CSS-FRAMEWORK.md

...understand test coverage → Read: tests/README.md → Run: pytest tests/ -v

...understand why this matters → Read: USEIT-PARADOX.md → Then: IT-JUST-WORKS.md


By Topic 📖

Browser Features

CSS Framework

Testing

History & Context

Philosophy

Project Management


By Reading Time ⏱️

Quick (5 minutes)

Medium (15 minutes)

Deep Dive (30+ minutes)


File Sizes & Stats 📈

FileSizeLinesPurpose
README.md~15 KB287Main documentation
QUICKSTART.md~18 KB325Getting started
PROJECT-STATUS.md~20 KB280Status report
SEMANTIC-CSS-FRAMEWORK.md~35 KB500+Framework philosophy
TEXT-WEB-HTML.md~25 KB400+HTML reference
IT-JUST-WORKS.md~20 KB325Simplicity essay
USEIT-PARADOX.md~45 KB900+Case study
WEB-DESIGN-HISTORY.md~40 KB600+Historical context
MOBILE-WEB-HISTORY.md~50 KB800+Mobile history
SESSION-SUMMARY.md~15 KB270Dev session notes
CONTINUATION-SUMMARY.md~12 KB280Follow-up notes
tests/README.md~8 KB150Test docs

Total documentation: ~300 KB, ~5,500+ lines


Key Concepts 🔑

The Tri-Hard Pattern

Splitting simple tasks across HTML + CSS + JavaScript + build configs. Makes everything harder.

Read: SEMANTIC-CSS-FRAMEWORK.md

Progressive Enhancement

HTML works standalone. CSS enhances. JavaScript is optional.

Read: IT-JUST-WORKS.md

Text-First Web

Pages that work in text browsers, enhanced for graphical browsers.

Read: TEXT-WEB-HTML.md

Differentiation > Conformity

Being remarkable beats being generic. useit.com learned this the hard way.

Read: USEIT-PARADOX.md

Simple > Complex

Until complexity is necessary. 13 KB beats 3 MB.

Read: SEMANTIC-CSS-FRAMEWORK.md


Learning Paths 🎓

Path 1: Practical User

  1. README.md - What is this?
  2. QUICKSTART.md - How do I use it?
  3. demo/index.html - Show me examples
  4. TEXT-WEB-HTML.md - Tag reference

Path 2: Philosophy Student

  1. IT-JUST-WORKS.md - Why simplicity matters
  2. SEMANTIC-CSS-FRAMEWORK.md - The Tri-Hard Pattern
  3. USEIT-PARADOX.md - Real-world case study
  4. WEB-DESIGN-HISTORY.md - Historical context

Path 3: Developer/Contributor

  1. PROJECT-STATUS.md - Current state
  2. tests/README.md - Test coverage
  3. SEMANTIC-CSS-FRAMEWORK.md - Design principles
  4. TEXT-WEB-HTML.md - Implementation details

Path 4: Historical Context

  1. WEB-DESIGN-HISTORY.md - Web evolution
  2. MOBILE-WEB-HISTORY.md - Mobile evolution
  3. USEIT-PARADOX.md - What went wrong
  4. IT-JUST-WORKS.md - Back to simple

Quotes to Know 💬

From the documentation:

"Somehow you captured modern and classic balance. Looks good, easy to read, lightweight, basic enough to read and edit manually if needed." - User feedback
"The funny thing is nngroup lost what made them special and an example and talking point of the web by 'fixing it'" - On differentiation
"Basic HTML and CSS works on Safari and Firefox. Funny." - On the irony of simplicity
"Don't lose what makes you special by trying to look like everyone else." - Core lesson

External Resources 🔗

  • Lynx browser: http://lynx.browser.org/
  • Jakob Nielsen: https://www.nngroup.com/
  • Web Archive (old useit.com): https://web.archive.org/
  • HTML Standards: https://html.spec.whatwg.org/

Navigation Tips 🧭

  1. Start broad, go deep - README → QUICKSTART → specific topics
  2. Follow your interest - Practical? Philosophy? History? Pick your path
  3. Use the demo - Best way to understand is to see it work
  4. Read the case study - USEIT-PARADOX.md teaches the most important lesson

Last Updated: 2025-01-28

Total Documentation: 12 files, ~5,500 lines, comprehensive coverage

Status: Complete and ready to use ✅