Anobium - 2025-01-28

See https://ko-fi.com/post/The-easy-way-to-help--improve-the-Help-V7V819P5US


The easiest way to help with GCSTUDIO and GCBASIC is to contribute to improving the Help documentation.

By enhancing and maintaining clear, accurate guides, you ensure that users have the resources they need to succeed.

The simplest way to get started is by using GCCODE, our integrated development environment designed to streamline your workflow:

  • Built-in AsciiDoc viewer for seamless documentation editing and previewing.
  • Real-time editing and live preview of documentation.
  • No additional software installation required—everything is integrated.
  • Familiar interface tailored for GCBASIC users, ensuring an intuitive experience.
  • Built-in AsciiDoc viewer for seamless documentation editing and previewing.
  • Real-time editing and live preview of documentation.
  • No additional software installation required—everything is integrated.
  • Familiar interface tailored for GCBASIC users, ensuring an intuitive experience.

Accessing Documentation in GCCODE

  • Launch GCCODE.
  • Navigate to File > Open Special > File:
  • Open your Help documentation source folder.
  • Files are categorized (e.g., Commands, Solutions, Best Practices).
  • Each .adoc file corresponds to a section of the documentation.
  • The primary index is located in gcbasic.adoc.

Using the GCCODE ADOC Viewer

  • Split-Screen View:
  • Left pane for editing .adoc files.
  • Right pane for a live preview of the formatted output.
  • Features:
  • Syntax highlighting for error-free formatting.
  • Table of contents for quick navigation.
  • Section folding for better organization.

Managing Documentation with GitHub

  • Files are synced with GitHub repositories for version control and collaboration.
  • Use Push and Pull commands within GCCODE to sync local changes with the GitHub repository.
  • Branching: Work on separate branches for edits to avoid overwriting main documentation.
  • For contributions, submit a pull request via GitHub after making and testing your changes.

Navigation Tips

  • Use the file tree on the left to browse documentation sections efficiently.
  • Quick Search (Ctrl+B) allows for easy file discovery.
  • Double-click any .adoc file to open it with the viewer.
  • Right-click options in the editor for common AsciiDoc formatting tasks.

Steps to Contribute

  1. Open GCCODE and access documentation via File > Open.
  2. Edit your .adoc file using the live preview feature.
  3. Test your changes for accuracy and formatting.
  4. Use GitHub tools in GCCODE to sync, review, and submit your changes.

This method keeps GitHub file management simple while emphasizing its relevance to contributors.

Let me know if further refinements are needed to this post.

 

Last edit: Anobium 2025-01-28