Discussions

Ask a Question
Back to All

Potential bug with shared names between guid & api reference categories & pages.

Hi there,

My name is Alexander, I'm a developer from FundApps. I am currently looking at using readme to consolidate our implementation and

I noticed a couple of issues in playing around.

If you create a category with the same name as an API reference that the admin window gets into a broken state where it becomes difficult to move pages and delete categories.

Similarly if you duplicate page names between your api reference and your guide, the api reference page appears in the guide.

Are these intended behaviours? It comes across to me like a potential issue if you are syncing documentation across 2 or more Github repositories (which don't have knowledge of the page titles between repositories). The first issue we can be careful about, but the second is harder to ensure safety.

Otherwise I am super keen on using ReadMe and will be presenting to my company!

Thanks,

Alex