Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a link subcommand to link ADRs to one another #32

Open
adoble opened this issue Jan 3, 2020 · 2 comments
Open

Add a link subcommand to link ADRs to one another #32

adoble opened this issue Jan 3, 2020 · 2 comments
Assignees

Comments

@adoble
Copy link
Owner

adoble commented Jan 3, 2020

No description provided.

@adoble adoble self-assigned this Jan 3, 2020
adoble added a commit that referenced this issue Mar 17, 2020
@adoble
Copy link
Owner Author

adoble commented Apr 4, 2020

This is proving more challenging than originally thought. To create a link between two existing ADRs, some meta information needs to be maintained in the ADR to show:

  • Where the link has to be created

  • What markup is associated with that link.

Currently once an ADR has been created, the fields for links such as {{{link.id}}} (a.k.a. the meta information) is overwritten. This needs to be preserved, but in a way that does not interfere with the markdown. Currently I’m looking at adding this information as markup comments. In addition, it would be nice to also preserve the semantics of what has been changed. In this way, future (sub)commands could, for instance, create a graph of the links.

As this seems to be a general problem - annotating markup with semantic information - I have started a new project semplate that should handle this as a library. If all goes to plan, I can link this into this project.

@adoble adoble mentioned this issue Feb 6, 2021
@adoble
Copy link
Owner Author

adoble commented Feb 11, 2024

Issue 32

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant