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

Cookbook files should define the custom_edit_url frontmatter #1608

Open
ElliotFriend opened this issue Sep 16, 2024 · 0 comments
Open

Cookbook files should define the custom_edit_url frontmatter #1608

ElliotFriend opened this issue Sep 16, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@ElliotFriend
Copy link
Contributor

Following on from #1541 and stellar/stellar-docs#840

If these cookbook docs remain here, each one will need to define its own custom_edit_url frontmatter value, so the "Edit this page" button on the bottom of each one points people in the right direction. Currently, clicking on that button from any of these pages results in a 404 error, since the file is no longer in the stellar-docs repo.

For example, the frontmatter of the "Payments and Assets" page should be adapted to look something like:

---
title: Payments and Assets
hide_table_of_contents: true
description: Send XLM, stellar classic, or a soroban asset using the Stellar CLI
custom_edit_url: https://github.com/stellar/stellar-cli/edit/main/cookbook/payments-and-assets.mdx
---

To send payments and work with assets ...

Docusaurus info about this frontmatter value: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#custom_edit_url.

@ElliotFriend ElliotFriend added the bug Something isn't working label Sep 16, 2024
@github-project-automation github-project-automation bot moved this to Backlog (Not Ready) in DevX Sep 16, 2024
@janewang janewang moved this from Backlog (Not Ready) to Todo (Ready for Dev) in DevX Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Todo (Ready for Dev)
Development

No branches or pull requests

2 participants