obsidian-plugin/banisterious_obsidian-custom-selected-word-count
1
0
Fork 0
mirror of https://github.com/banisterious/obsidian-custom-selected-word-count.git synced 2026-07-22 05:49:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
banisterious_obsidian-custo.../docs
History
banisterious adbed06f8a chore(docs): archive audit planning docs 
Audit is complete (1.7.1 shipped, catalog scan clean), so the planning
docs are now historical reference rather than active roadmap:

- docs/planning/audit-implementation-plan.md       -> archive/
- docs/planning/audit-phase-4-tests.md             -> archive/
- docs/planning/audit-phase-5-split.md             -> archive/
- docs/planning/audit-phase-6-cleanup.md           -> archive/

docs/planning/ now contains only the archive/ subdirectory. Future
non-audit planning work can land alongside as needed.
2026-05-13 13:09:03 -07:00
..
architecture docs(architecture): add post-Phase-5 architecture overview 2026-05-13 12:43:11 -07:00
archive feat: v1.6.0 - Canvas integration, modal redesign, and smart quote fixes 2025-07-21 11:37:11 -07:00
assets/templates docs: fix broken Buy Me a Coffee anchor and remove dead architecture refs 2026-05-12 10:45:06 -07:00
developer feat(ci): release workflow with build-provenance attestations 2026-05-12 15:21:28 -07:00
images docs: add demo2.gif for enhanced documentation 2025-07-21 16:36:05 -07:00
planning/archive chore(docs): archive audit planning docs 2026-05-13 13:09:03 -07:00
user docs: fix broken Buy Me a Coffee anchor and remove dead architecture refs 2026-05-12 10:45:06 -07:00
README.md docs: fix broken Buy Me a Coffee anchor and remove dead architecture refs 2026-05-12 10:45:06 -07:00

README.md

Documentation Hub

Executive Summary

Welcome to the Custom Selected Word Count (OCSWC) plugin documentation. This hub provides comprehensive information for users, developers, and contributors. Navigate using the sections below to find the information you need.

Quick Navigation

For Users

For Developers

For Planning

Documentation Structure

User Documentation (user/)

Guides (user/guides/)

Step-by-step instructions for accomplishing specific tasks:

Concepts (user/concepts/)

Explanations of underlying principles and concepts:

Reference (user/reference/)

Detailed reference materials for looking up specific information:

Developer Documentation (developer/)

Architecture (developer/architecture/)

High-level system design and architectural decisions:

  • Documentation to be added as the codebase split lands

Implementation (developer/implementation/)

Code organization, patterns, and implementation details:

  • Documentation to be added as development progresses

Testing (developer/testing/)

Testing strategies, procedures, and guidelines:

  • Documentation to be added as testing framework is established

Contributing (developer/contributing/)

Guidelines for contributors and maintainers:

  • Documentation to be added for community contribution guidelines

Planning Documentation (planning/)

Features (planning/features/)

Feature planning and roadmap documentation:

  • Feature plans to be added as they are developed

Requirements (planning/feature-requirements/)

Detailed requirements for specific features:

  • Requirements documentation to be added for major features

Assets (assets/)

Images (assets/images/)

Screenshots, diagrams, and visual aids:

  • User interface screenshots
  • Feature demonstration images
  • Architectural diagrams

Templates (assets/templates/)

Document templates and style guides:

Archive (archive/)

Historical documents and deprecated content:

  • Legacy specifications
  • Outdated feature plans
  • Superseded documentation

Getting Started

New Users

  1. Start with the Getting Started Guide
  2. Review Word Counting Principles to understand the plugin's behavior
  3. Consult the Settings Reference for detailed configuration options

Developers

  1. Explore the implementation documentation (coming soon)
  2. Review testing guidelines before contributing code

Contributors

  1. Check the contributing guidelines (coming soon)
  2. Review the documentation style guide: documentation-style-guide.md
  3. Understand the project architecture and requirements

Document Conventions

Naming Standards

  • Use kebab-case for all file names: getting-started.md, word-counting-principles.md
  • Organize documents by audience and purpose
  • Use descriptive, searchable names

Writing Style

  • Voice: Second person ("you") when addressing users directly
  • Tense: Present tense for actions and descriptions
  • Tone: Clear, helpful, and professional
  • Structure: Executive summary, table of contents, numbered sections

Cross-References

  • Use relative paths for internal links
  • Provide context when linking to other sections
  • Include section anchors for deep linking
  • Maintain link accuracy across document moves

Maintenance and Updates

Document Lifecycle

  • Creation: Follow templates and style guide
  • Review: Technical and editorial review process
  • Updates: Keep current with plugin development
  • Archive: Move outdated content to archive section

Version Control

  • Track changes through git history
  • Update modification dates in document footers
  • Coordinate updates with plugin releases
  • Maintain backwards compatibility for links

Quality Assurance

  • Regular link checking for internal references
  • Screenshot updates for UI changes
  • Technical accuracy reviews
  • Accessibility compliance verification

External Resources

Project Links

Obsidian Resources

Development Tools

Support and Feedback

Getting Help

  1. Search this documentation for relevant information
  2. Check the troubleshooting section in the user guide
  3. Review GitHub Issues for known problems
  4. Create a new issue with detailed information if needed

Contributing to Documentation

  • Follow the documentation style guide
  • Submit pull requests for improvements
  • Report documentation issues through GitHub
  • Suggest new documentation topics

Feedback Welcome

  • Documentation clarity and usefulness
  • Missing information or topics
  • Technical accuracy concerns
  • Accessibility improvements

Last updated: June 7, 2025

This documentation hub is maintained alongside the Custom Selected Word Count plugin development. For the most current information, always refer to the latest version in the main branch.