makeplane / makeplane/plane

[feature]: Page or description slash commands for a module

Open
#5,526 0 comments 2 reactions 2 assignees View on GitHub

@vihar is already working on this.

Since Sep 4, 2024.

✍️editor ✨feature
Dominant language
TypeScript
Stars
59.6k
Forks
5.8k
Avg merge
1d 22h
Merged PRs (30d)
49

Description

Is there an existing issue for this?
  • I have searched the existing issues
Summary

One problem I'm trying to solve or mitigate for is keeping feature documentation easy to find. At present, we use Notion for project/feature documents and Jira for ticketing. Linking a ticket to a Notion doc for context is less than ideal. Plane allows associating tickets with modules, which is a start. If a module could have a page or use markdown for the description, however, all documentation associated with a module (feature) could be easily found and referenced by all working on the associated tickets.

End state
Module descriptions can use slash commands, or can have an associated page

NOTE: This is not the same as https://github.com/makeplane/plane/issues/1621, which requests the ability to link to an existing page.

Why should this be worked on?

As an engineer or product manager, I would like to ensure context is always available to anyone working on a ticket or looking through the scope of a project. If the module page is the source of truth, and all tickets are associated with the module, then this minimizes the risk of being unable to find documentation.

Contributor guide

Open the contributing guide

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.