Discussions
CICD of subpages in documentation
Hi, :grinning: I am setting up a pipeline with github actions of my documentation and there are some subpages.
In order to do that I am generating the YAML blocks that need to be at the top of the markdown files and writing them into the files. All far all good.
The problems start when I want to have a subpage because they way to indicate this is by adding a new key with the parent document ID. I want to have a generic solution that doesn't involve hardcoding IDs. What I was planning to do is first upload the parent documents, then get their IDs and use those for the second round of uploads, where I would upload all of the children documents that reference their parent.
Is there any other easier solution? TY
Posted by null about 1 month ago
How to redirect URL to a different project?
Example:
If Project A URL can be redirected to Project B URL.
Posted by Deepesh Lakhera about 1 month ago
what happens if a delete a version in ReadMe?
I want to delete a deprecated version in ReadMe. What will happen if I proceed with the deletion?
Posted by null about 1 month ago
Hiding "last seen" not possible
Hi, I want to hide "last updated at" in all my docs. Is there a way to do this on Readme?
Posted by Houseware Support about 1 month ago
The Guide is always seems to get out of sync.
I'm not sure what's happening, but we're updating the API Reference, but then when it's published and a new version is created, it seems to take an older version of the guides.
Also is there anyway to sync or replace the guides version? Or do I have to retype in everything on the new version
Posted by Dan Parker 2 months ago
Segment Integration page view "Category"
The Segment integration map the page path instead of the actual category the page is nested in.
```
analytics.page('/docs/deduplication', 'Deduplication', {
category: '/docs/deduplication',
context: {
plugin: {
name: 'readme_io',
version: '1.0.0'
}
},
name: 'Deduplication',
path: '/docs/custom-event-triggers',
referrer: 'https://anytrack.io/',
search: '',
title: 'PageView Click ID identifier: atclid',
url: 'https://readme.anytrack.io/docs/custom-event-triggers'
});
```
Posted by laurent malka 2 months ago
Webhooks in API reference?
Hi there,
Several months ago you added the ability to render webhooks within the API reference.
However, recently the webhooks seem to have disappeared. Is there a configuration option you can use to determine whether or not webhooks display in the API reference? I can't find one anywhere, nor any reference to this in the Readme changelog.
It's possible something did change on our end (but I don't think so), so I'm guessing there's something I'm overlooking here. Any help is greatly appreciated!
Posted by Thomas Harrington 2 months ago
Markdown tables in a description field?
I was trying to add a table into the description of a field in my yml using markdown, and the table was not rendered in the api. I'm using the exact markdown in the documentation for tables:
<br />
```
description: >
Occupation Type info
**Bold**
`code style`
| Left | Center | Right |
|:-----|:--------:|------:|
| L0 | **bold** | $1600 |
| L1 | `code` | $12 |
| L2 | _italic_ | $1 |
```
```
```
<br />
Other markdown is getting rendered in the description, but the table is not rendered. Are tables not supported in description fields?
Posted by Patrick Nichols 2 months ago
Markdown tables in a description field?
I was trying to add a table into the description of a field in my yml using markdown, and the table was not rendered in the api. I'm using the exact markdown in the documentation for tables:
<br />
```
description: >
Occupation Type info
**Bold**
`code style`
| Left | Center | Right |
|:-----|:--------:|------:|
| L0 | **bold** | $1600 |
| L1 | `code` | $12 |
| L2 | _italic_ | $1 |
```
```
```
<br />
Other markdown is getting rendered in the description, but the table is not rendered. Are tables not supported in description fields?
Posted by Patrick Nichols 2 months ago
Tags for filtering within changelog article
I would like to have the opportunity to assign tags to changelog articles, which eventually can be used for filtering reasons (like it is done in discussions). As the list of changelog is growing rapidly (over four pages right now) covering multiple features/epics, it is hard to track down what is relevant right now if I am just looking for a specific part of the software.
So to be more conrete:
- Add tags in the meta-data of a changelog article
- Option to show the tags in the frontend of the changelog article (somewhere)
- Show a list of all used tags
- Onclick on a tag shows only the changelog articles with that specific tag assigned
Is this possible already, or can it be added to the roadmap please?
Posted by Dick Vloedgraven 3 months ago