TurboDocx / TurboDocx/Docs

Production cutover: Enable new template documentation structure

Open
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
2
Forks
2
Avg merge
5h 41m
Merged PRs (30d)
5

Description

Summary

New template documentation structure has been implemented with separate pages for document and presentation templates. Need to cut over production build to use the new documentation structure.

Changes Ready for Production

  • Document Template Page: How to Create a Document Template.md - Ready for production
  • Presentation Template Page: How to Create a Presentation Template.md - Currently commented out pending screenshots
  • Template Troubleshooting: Updated and improved with better formatting
  • Video Embeds: Added to both template creation and troubleshooting pages

Tasks for Production Cutover

Phase 1: Document Templates (Ready Now)
  • Update sidebar navigation to include new "How to Create a Document Template" page
  • Ensure proper sidebar positioning (should be position 1)
  • Test all links and video embeds work correctly
  • Update any internal references to point to new document template page
Phase 2: Presentation Templates (After Screenshots)
  • Uncomment the presentation template page content
  • Add screenshots for PowerPoint variable setup process
  • Update sidebar navigation to include presentation template page
  • Test presentation template page functionality
Phase 3: Cleanup
  • Remove original "How to Create a Template" page (see issue #8)
  • Update any remaining internal links
  • Verify all documentation flows correctly

Files Involved

  • docs/TurboDocx Templating/How to Create a Document Template.md
  • docs/TurboDocx Templating/How to Create a Presentation Template.md
  • docs/TurboDocx Templating/Template Troubleshooting.md
  • docs/TurboDocx Templating/How to Create a Template.md (to be deprecated)

Dependencies

  • Presentation template screenshots needed before Phase 2
  • Issue #8 completion for Phase 3

Success Criteria

  • Users can easily find separate guides for document vs presentation templates
  • All video tutorials work correctly
  • Template troubleshooting page is easily accessible and well-formatted
  • No broken links or references

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the four files under docs/TurboDocx Templating and the current sidebar navigation. Verify the document-template links and video embeds first, then check the presentation page's screenshot dependency and issue #8 before handling the remaining phases. Done means the new guides are discoverable, links and videos work, and no obsolete references remain.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.