intersystems / intersystems/ipm

Proposal: GitHub Pages Website for IPM

Open
#997 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
ObjectScript
Stars
41
Forks
29
Avg merge
23h 54m
Merged PRs (30d)
4

Description

## Proposal: GitHub Pages Website for InterSystems Package Manager (IPM)

The **InterSystems Package Manager (IPM)** is a core tool for discovering, installing, and managing InterSystems packages. While the GitHub repository contains the source code and documentation, a **dedicated GitHub Pages website** would significantly improve visibility, usability, and onboarding for new and existing users.

### Purpose of the GitHub Page

The GitHub Pages site would serve as a **central, user-friendly entry point** for IPM, complementing the existing repository.

### Proposed Content

* **Overview of IPM**

* What IPM is and why it is useful
* Key features and benefits
* **Getting Started**

* Installation instructions
* Basic usage examples
* **Commands & Usage**

* Common IPM commands
* Simple examples
* **Package Discovery**

* How to find and install community packages
* **Documentation Links**

* Links to the GitHub repo, README, and related resources
* **Community & Contribution**

* How to contribute packages
* Links to discussions and issues

### Benefits

* Improves **discoverability** of IPM
* Provides a **clean landing page** for first-time users
* Separates **documentation presentation** from source code
* Easy to maintain using Markdown (`.md`) and GitHub Pages
* No additional hosting cost

Image

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.