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

Get docs for category (/categories/slug/docs) is confusing #16

Closed
maxpumperla opened this issue Feb 15, 2019 · 4 comments
Closed

Get docs for category (/categories/slug/docs) is confusing #16

maxpumperla opened this issue Feb 15, 2019 · 4 comments

Comments

@maxpumperla
Copy link

This one: https://readme.readme.io/reference/categories#get_categories-slug-docs

The description suggests that you can retrieve the docs for a category, but you need to provide a slug, not a category. So I guess that means you get all docs for the category associated with this slug? Please clarify.

@domharrington
Copy link
Member

You need to provide the category slug, not a doc slug. As I said in #15, the category slug isn't typically surfaced with a regular readme setup. It's auto generated based on name on creation.

Adding a new doc in the dash does allow you to see the category slug:
image

@maxpumperla
Copy link
Author

@domharrington ok, thanks for clarifying. you seem to call everything a "slug" in your documentation. it's sometimes difficult to know what that refers to. So you have "category slug" and "document slug". the categories endpoints use the former. good to know.

@maxpumperla
Copy link
Author

@domharrington sorry, I checked again and still have problems retrieving the category slug. I can't confirm that I can see the document slug in the UI, even if I create new documents, as you suggested. Here is one example (it's the same in dash, but I can't share that):

https://docs.skymind.ai/docs/data-utilities-transforms

this does not come with the "workflow" document slug that I know exists (by checking the /categories/slug API). The real problem is that I have a few categories whose slugs I can't reverse engineer for the life of mine. We have a category called "Getting Started" that has been called like that since the dawn of time (afaict), but its slug is none of the obvious regex-able candidates.

What do I do? Is there absolutely 0 chance to get the category slug from anywhere?

@domharrington
Copy link
Member

domharrington commented Feb 19, 2019

If you click the + button in the dash:
image

You'll see the category slug in the URL right before /add:
image

Your slug appears to be bb for that category.

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

No branches or pull requests

2 participants