godotengine / godotengine/godot-docs

De-duplicate BBCodes information

Open
#9,998 6 comments 3 reactions 0 assignees View on GitHub
area:engine details area:manual content:new page content:organization enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

Referring to https://github.com/godotengine/godot-docs/pull/9996#issuecomment-2373129310, BBCodes are currently documented ~~3~~ ~5~ 4 times:

- [GDScript documentation comments](https://docs.godotengine.org/en/latest/tutorials/scripting/gdscript/gdscript_documentation_comments.html#bbcode-and-class-reference)
- ~[GDExtension documentation system](https://docs.godotengine.org/en/latest/tutorials/scripting/gdextension/gdextension_docs_system.html#documentation-styling)~
- [Class reference primer](https://docs.godotengine.org/en/latest/engine_details/class_reference/index.html)
- [RichTextLabel](https://docs.godotengine.org/en/stable/tutorials/ui/bbcode_in_richtextlabel.html)
- [Class Reference Translation](https://docs.godotengine.org/en/stable/contributing/documentation/editor_and_docs_localization.html#class-reference-bbcode)

It might be better to have a separate, independent page for bbcodes. If the info from RichTextLabel should not be merged into the ones for the documentation system, at least the others can be merged together as they really are the same use-case.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.