Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README #7

Closed
jxmot opened this issue Mar 21, 2022 · 3 comments
Closed

Update README #7

jxmot opened this issue Mar 21, 2022 · 3 comments
Assignees
@jxmot
Labels
documentation Improvements or additions to documentation

Comments

@jxmot
Copy link
Owner

jxmot commented Mar 21, 2022 •
edited
Loading

  • gallery & lightbox
  • README images
  • contact form
  • theme switch
  • devdebug
  • auto adjust CSS and "bypass"
@jxmot jxmot added the documentation Improvements or additions to documentation label Mar 21, 2022
@jxmot jxmot self-assigned this Mar 21, 2022
@jxmot
Copy link
Owner Author

jxmot commented Mar 26, 2022 •
edited
Loading

Consider separating README into chapters (individual files):

This is a DRAFT outline -

  • CH 1 - Overview
    • Purpose
    • High Level Details
      • Technologies
      • File Organization
        • Naming Conventions
        • Folder Hierarchy
  • CH 2 - Features
    • Gallery
    • Lightbox
    • Contact Form
    • Theme Switch
    • Develop & Debug
      • Purpose
      • Details
  • CH 3 - Desktop vs Mobile
    • Browsers Used for Testing
    • Visible Differences
    • Browser Detection
    • On the Fly CSS Changes
      • Body
      • To Top
      • Lightbox
  • CH 4 - Deep Details
    • index.html
      • <head>
      • <body>
        • Navigation Bar
          • Logo or No Logo
          • Hamburger Icon
          • Menu
        • Primary Content
          • Home
          • Gallery
          • Themes
          • Contact
          • Debug Output
        • Lightbox Modal
        • Page Footer
          • Go to Top Button
    • CSS
    • JavaScript and JQuery
      • Logo Control
      • Lightbox
      • Contact Form
      • To Top
      • Get Browser Info
      • Utilities
    • Miscellaneous
      • htaccess
  • CH 5 - Modification Guidelines
    • Where to Start
    • Removing Features
    • Adding Features

@jxmot
Copy link
Owner Author

jxmot commented Mar 28, 2022

deferring changes until a release after v2.0.0

@jxmot
Copy link
Owner Author

jxmot commented Apr 4, 2022

Reduced to 4 chapters, documentation is DRAFT

@jxmot jxmot closed this as completed Apr 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jxmot jxmot

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jxmot