Bogdan-Lyashenko / codecrumbs

Learn, design or document codebase by putting breadcrumbs in source code. Live updates, multi-language support and more.
https://codecrumbs.io
BSD 3-Clause "New" or "Revised" License
2.71k stars 101 forks source link

Codecrumbs text get cut off #50

Open RingoKam opened 5 years ago

RingoKam commented 5 years ago

First of all, awesome package!!!👏👏👏

I am using Codecrumbs to document a new C# project at work. I ran into an issue when my descriptions are too long and they get cut off from the svg. See below.

image

Bogdan-Lyashenko commented 5 years ago

@RingoKam Hi, thanks)

I will have a look, but I think you may want to use description instead. See white box below image To do so, you just need to separate codecrumbs title from description by ;. E.g. //cc:signin#1;firebase sign in;call to firebase with auth provider, proceed if success response

It's cool you use it for documentation, how is it going overall? Do you see some features are missing or some improvements it would be nice to add? It's just the beginning, so I am trying to gather all feedback possible to make codecrumbs really useful ;) Thanks.

RingoKam commented 5 years ago

Thanks for the quick response! I must have missed it in the documentation.

Its going well so far. When I was using the browser, I thought it would be nice to have sort a "table of content" for the trail I am looking at. Sort of like the crumb on the sidebar right now, but with the steps of each trail.

image to something like below? image

Bogdan-Lyashenko commented 5 years ago

Nice. I see, I’ll add that to backlog)