Macaulay2 / Macaulay2/M2

Symlink to an existing documentation node

Open
#3,230 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation
Dominant language
Macaulay2
Stars
435
Forks
297
Avg merge
4d 20h
Merged PRs (30d)
11

Description

Consider the documentation for [image](https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/Macaulay2Doc/html/_image.html). Say I want to document the missing node for `image(SheafMap)`, but I don't necessarily want to make a new node and I'd rather `viewHelp(image, SheafMap)` just open the page for `image` and, importantly, the link to `image(SheafMap)` in the documentation of `Varieties` to link to the page for `image` in `Macaulay2Doc`.

Is this possible?

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 with the linked image documentation page and inspect how viewHelp(image, SheafMap) resolves its target and how the image(SheafMap) reference in Varieties is linked. Determine whether both references can resolve to the existing image page without creating a new node; done means the requested lookup and documentation link open that page consistently.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.